.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "VOS_CREATE 1" .TH VOS_CREATE 1 2024-03-20 OpenAFS "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME vos_create \- Creates a read/write volume and associated VLDB entry .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBvos create\fR \fB\-server\fR\ <\fImachine\ name\fR> \fB\-partition\fR\ <\fIpartition\ name\fR> \fB\-name\fR\ <\fIvolume\ name\fR> [\fB\-maxquota\fR\ <\fIinitial\ quota\ (KB)\fR>] [\fB\-id\fR\ <\fIvolume\ id\ number\fR>] [\fB\-roid\fR\ <\fIRO\ volume\ id\ number\fR>] [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-verbose\fR] [\fB\-encrypt\fR] [\fB\-noresolve\fR] [\fB\-config\fR\ <\fIconfig\ directory\fR>] [\fB\-help\fR] .PP \&\fBvos cr\fR \fB\-s\fR\ <\fImachine\ name\fR> \fB\-p\fR\ <\fIpartition\ name\fR> \fB\-na\fR\ <\fIvolume\ name\fR> [\fB\-m\fR\ <\fIinitial\ quota\fR>] [\fB\-i\fR\ <\fIvolume\ id\ number\fR>] [\fB\-r\fR\ <\fIRO\ volume\ id\ number\fR>] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-noa\fR] [\fB\-l\fR] [\fB\-v\fR] [\fB\-e\fR] [\fB\-nor\fR] [\fB\-co\fR\ <\fIconfig\ directory\fR>] [\fB\-h\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" The \fBvos create\fR command creates a read/write volume with the name specified by the \fB\-name\fR argument at the site specified by the \fB\-server\fR and \fB\-partition\fR arguments. In addition, the command allocates or sets the following: .IP \(bu 4 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. .IP \(bu 4 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 \fBfs mkmount\fR 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 \f(CW\*(C`l\*(C'\fR (lookup) and \f(CW\*(C`a\*(C'\fR (administer) permissions on every ACL to members of the system:administrators group, even when the group does not appear on an ACL; use the \fB\-implicit\fR argument to the \fBfileserver\fR initialization command to alter the set of rights on a server-by-server basis if desired.) .IP \(bu 4 The volume's space quota, set to 5000 kilobyte blocks by default. Use the \&\fB\-maxquota\fR argument to specify a different quota, or use the \fBfs setquota\fR command to change the volume's quota after mounting the volume with the \fBfs mkmount\fR command. .PP The volume is empty when created. To access it via the Cache Manager, mount it in the file space by using the \fBfs mkmount\fR command. .SH CAUTIONS .IX Header "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 \fBfs_listquota\fR\|(1). .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-server\fR <\fIserver name\fR>" 4 .IX Item "-server " 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 \&\fBvos\fR\|(1). .IP "\fB\-partition\fR <\fIpartition name\fR>" 4 .IX Item "-partition " Identifies the partition on which to create the read/write volume, on the file server machine specified by the \fB\-server\fR argument. Provide the partition's complete name with preceding slash (for example, \f(CW\*(C`/vicepa\*(C'\fR) or use one of the three acceptable abbreviated forms. For details, see \&\fBvos\fR\|(1). .IP "\fB\-name\fR <\fIvolume name\fR>" 4 .IX Item "-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 \f(CW\*(C`.backup\*(C'\fR or \f(CW\*(C`.readonly\*(C'\fR 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. .IP "\fB\-maxquota\fR <\fIinitial quota\fR>" 4 .IX Item "-maxquota " Specifies the maximum amount of disk space the volume can use. The size should be a positive integer followed by an optional suffix: \f(CW\*(C`K\*(C'\fR for kibibytes (1024 bytes, the default), \f(CW\*(C`M\*(C'\fR for mebibytes (1024 kibibytes), \&\f(CW\*(C`G\*(C'\fR for gibibytes (1024 mebibytes), and \f(CW\*(C`T\*(C'\fR for tebibytes (1024 gibibytes). The value \f(CW0\fR (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 \f(CW\*(C`5000K\*(C'\fR. .IP "\fB\-id\fR <\fIvolume ID\fR>" 4 .IX Item "-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. .IP "\fB\-roid\fR <\fIreadonly volume ID\fR>" 4 .IX Item "-roid " 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 \fBvos addsite\fR is run; if a volume does not have a readonly volume ID associated with it by the time \&\fBvos release\fR is run, a volume ID will be allocated for it. .Sp 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. .Sp As with the \fB\-id\fR 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. .IP "\fB\-cell\fR <\fIcell name\fR>" 4 .IX Item "-cell " Names the cell in which to run the command. Do not combine this argument with the \fB\-localauth\fR flag. For more details, see \fBvos\fR\|(1). .IP \fB\-noauth\fR 4 .IX Item "-noauth" Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not combine this flag with the \fB\-localauth\fR flag. For more details, see \&\fBvos\fR\|(1). .IP \fB\-localauth\fR 4 .IX Item "-localauth" Constructs a server ticket using a key from the local \&\fI/etc/openafs/server/KeyFile\fR file. The \fBvos\fR command interpreter presents it to the Volume Server and Volume Location Server during mutual authentication. Do not combine this flag with the \fB\-cell\fR argument or \&\fB\-noauth\fR flag. For more details, see \fBvos\fR\|(1). .IP \fB\-verbose\fR 4 .IX Item "-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. .IP \fB\-encrypt\fR 4 .IX Item "-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. .IP \fB\-noresolve\fR 4 .IX Item "-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. .IP "\fB\-config\fR <\fIconfiguration directory\fR>" 4 .IX Item "-config " Set the location of the configuration directory to be used. This defaults to \&\fI/etc/openafs\fR, except if \fB\-localauth\fR is specified, in which case the default is \fI/etc/openafs/server\fR. This option allows the use of alternative configuration locations for testing purposes. .IP \fB\-help\fR 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH OUTPUT .IX Header "OUTPUT" The Volume Server produces the following message to confirm that it created the volume: .PP .Vb 1 \& Volume created on partition of .Ve .SH EXAMPLES .IX Header "EXAMPLES" The following command creates the read/write volume \f(CW\*(C`user.pat\*(C'\fR on the \&\fI/vicepf\fR partition of the file server machine \f(CW\*(C`fs4.example.com\*(C'\fR. .PP .Vb 2 \& % vos create \-server fs4.example.com \-partition /vicepf \-name user.pat \& Volume user.pat created on partition /vicepf of fs4.example.com .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the machine specified with the \fB\-server\fR argument and on each database server machine. If the \fB\-localauth\fR flag is included, the issuer must instead be logged on to a server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBvos\fR\|(1) .SH COPYRIGHT .IX Header "COPYRIGHT" IBM Corporation 2000. All Rights Reserved. .PP 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.