Command Reference Manual

vos remove

Purpose

Removes a volume from a site

Synopsis

 
vos remove [-server <machine name>]  [-partition <partition name>]
           -id <volume name or ID>  [-cell <cell name>]
           [-noauth]  [-localauth]  [-verbose]  [-help]
    
vos remo [-s <machine name>]  [-p <partition name>]  -i <volume name or ID> 
         [-c <cell name>]  [-n]  [-l]  [-v]  [-h]

Description

The vos remove command removes the indicated volume from the site (which may or may not be specified by the -server and -partition arguments). The Volume Location Database (VLDB) records the removal, with the precise results described below.

Use this command to remove any of the three types of volumes; the exact effect differs for the types:

Removing a ReadWrite volume automatically removes its associated Backup copy as well. The site information for both is removed from the VLDB entry, but their volume IDs are still recorded. ReadOnly sites, if any, are not affected. The whole VLDB entry is removed if there are no ReadOnly sites.
Removing ReadOnly copies must be done on a site-by-site basis, as specified by the -server and -partition arguments. The specified site is erased from the VLDB entry. Removing a Backup copy does not erase its volume ID.

This command is appropriate in almost all circumstances. Other commands (the vos delentry, vos remsite and vos zap commands) are available for removing volumes or VLDB entries, but by definition they can put the volumes and VLDB out of sync. Use them only in the special circumstances mentioned in their command descriptions.

Options

-server

Identifies the file server machine that houses the volume to remove.

Provide the machine's IP address or its host name (either fully qualified or using an unambiguous abbreviation). For details, see the introductory reference page for the vos command suite.

-partition

Identifies the partition (on the file server machine specified by the -server argument) that houses the volume to remove.

-id

Specifies either the complete name or volume ID number of a volume of the any of the three types. When removing a ReadOnly or Backup volume, avoid accidentally removing the ReadWrite source by specifying either the appropriate extension (.readonly or .backup) if providing a name or the appropriate volume ID number if providing a number.

Note:

If you are removing a volume without specifying the -server and -partition arguments, you must supply the -id argument in front of the volume name or id.

Provide the partition's complete name with preceding slash (for example, /vicepa) or use one of the three acceptable abbreviated forms. For details, see the introductory reference page for the vos command suite.

-cell

Names the cell in which to run the command. Do not combine this argument with the -localauth flag. For more details, see the introductory vos reference page.

-noauth

Assigns the unprivileged identity anonymous to the issuer. Do not combine this flag with the -localauth flag. For more details, see the introductory vos reference page.

-localauth

Constructs a server ticket using a key from the local /usr/afs/etc/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 the introductory vos reference page.

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

-help

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

Examples

The following example removes the ReadWrite volume user.terry and its Backup version, if any, from their site (the /vicepc partition on the file server machine fs3.abc.com).

% vos remove -server fs3.abc.com -partition c -id user.terry

The following example removes the ReadOnly volume root.afs.readonly from one of its sites, the /vicepa partition on the file server machine fs1.abc.com.

% vos remove -server fs1.abc.com -partition a -id root.afs.readonly

Privilege Required

The issuer must be listed in the /usr/afs/etc/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.

Related Information