Provided by: openafs-client_1.8.0~pre5-1ubuntu1.2_amd64 bug

NAME

       vos_create - Creates a read/write volume and associated VLDB entry

SYNOPSIS

       vos create -server <machine name>
           -partition <partition name>
           -name <volume name>
           [-maxquota <initial quota (KB)>]
           [-id <volume id number>]
           [-roid <RO volume id number>]
           [-cell <cell name>]
           [-noauth] [-localauth] [-verbose]
           [-encrypt] [-noresolve]
           [-config <config directory>]
           [-help]

       vos cr -s <machine name> -p <partition name>
           -na <volume name> [-m <initial quota>]
           [-i <volume id number>]
           [-r <RO volume id number>]
           [-c <cell name>] [-noa] [-l] [-v]
           [-e] [-nor]
           [-co <config directory>]
           [-h]

DESCRIPTION

       The vos create command creates a read/write volume with the name specified by the -name
       argument at the site specified by the -server and -partition arguments. In addition, the
       command allocates or sets the following:

       •   Volume ID numbers for the read/write volume and its associated read-only and backup
           volumes (this command does not actually create the latter two types of volume). A
           volume ID number is an identification number guaranteed to be unique within a cell.

       •   An access control list (ACL) associated with the volume's root directory, which takes
           the same name as volume's mount point when the volume is mounted with the fs mkmount
           command. An entry that grants all seven permissions to the members of the
           system:administrators group is automatically placed on the ACL. (In addition, the File
           Server by default always implicitly grants the "l" (lookup) and "a" (administer)
           permissions on every ACL to members of the system:administrators group, even when the
           group does not appear on an ACL; use the -implicit argument to the fileserver
           initialization command to alter the set of rights on a server-by-server basis if
           desired.)

       •   The volume's space quota, set to 5000 kilobyte blocks by default. Use the -maxquota
           argument to specify a different quota, or use the fs setquota command to change the
           volume's quota after mounting the volume with the fs mkmount command.

       The volume is empty when created. To access it via the Cache Manager, mount it in the file
       space by using the fs mkmount command.

CAUTIONS

       Currently, the maximum quota for a volume is 2 terabytes (2^41 bytes). Note that this only
       affects the volume's quota; a volume may grow much larger if the volume quota is disabled.
       However, volumes over 2 terabytes in size may be impractical to move, and may have their
       size incorrectly reported by some tools, such as fs_listquota(1).

OPTIONS

       -server <server name>
           Identifies the file server machine on which to create the read/write volume. 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 on which to create the read/write volume, on the file server
           machine specified 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).

       -name <volume name>
           Specifies a name for the read/write volume. The maximum length is 22 characters, which
           can include any alphanumeric or punctuation character. By convention, periods separate
           the fields in a name.  Do not apply the ".backup" or ".readonly" extension to a
           read/write volume name; they are reserved for the Volume Server to add to the
           read/write name when creating those backup and read-only volumes respectively.

       -maxquota <initial quota>
           Specifies the maximum amount of disk space the volume can use.  The size should be a
           positive integer followed by an optional suffix: "K" for kibibytes (1024 bytes, the
           default), "M" for mebibytes (1024 kibibytes), "G" for gibibytes (1024 mebibytes), and
           "T" for tebibytes (1024 gibibytes).  The value 0 (zero) grants an unlimited quota, but
           the size of the disk partition that houses the volume places an absolute limit on its
           size.  If this argument is omitted, the default value is "5000K".

       -id <volume ID>
           Specifies the volume ID for the read/write volume. If this options is not specified,
           or the given volume ID is 0, a volume ID will be allocated for the volume
           automatically. The volume IDs allocated should be fine for almost all cases, so you
           should almost never need to specify this option.

       -roid <readonly volume ID>
           Specifies the volume ID for the readonly volume corresponding to the read/write volume
           that is being created. The readonly volume will not be created; this merely specifies
           what volume ID the readonly volume will use when it is created. If a volume ID of 0 is
           specified here, no readonly volume ID will be assigned to the created volume
           immediately. A readonly volume ID can still be assigned later when vos addsite is run;
           if a volume does not have a readonly volume ID associated with it by the time vos
           release is run, a volume ID will be allocated for it.

           If this option is not specified, the default readonly volume ID is one number higher
           than the read-write volume ID, whether or not that ID was manually specified.

           As with the -id option, the default allocated volume IDs should be sufficient 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.

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

OUTPUT

       The Volume Server produces the following message to confirm that it created the volume:

          Volume <volume_ID> created on partition <partition_name> of <machine_name>

EXAMPLES

       The following command creates the read/write volume "user.pat" on the /vicepf partition of
       the file server machine "fs4.example.com".

          % vos create -server fs4.example.com -partition /vicepf -name user.pat
          Volume user.pat created on partition /vicepf of fs4.example.com

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)

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.