doc/man-pages/pod1/vos_create.pod.in

   1 =head1 NAME
   2
   3 vos_create - Creates a read/write volume and associated VLDB entry
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos create> S<<< B<-server> <I<machine name>> >>>
  11     S<<< B<-partition> <I<partition name>> >>>
  12     S<<< B<-name> <I<volume name>> >>>
  13     S<<< [B<-maxquota> <I<initial quota (KB)>>] >>>
  14     S<<< [B<-cell> <I<cell name>>] >>>
  15     [B<-noauth>] [B<-localauth>] [B<-verbose>]
  16     [B<-encrypt>] [B<-noresolve>] [B<-help>]
  17
  18 B<vos cr> S<<< B<-s> <I<machine name>> >>> S<<< B<-p> <I<partition name>> >>>
  19     S<<< B<-na> <I<volume name>> >>> S<<< [B<-m> <I<initial quota>>] >>>
  20     S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>] [B<-v>]
  21     [B<-e>] [B<-nor>] [B<-h>]
  22
  23 =for html
  24 </div>
  25
  26 =head1 DESCRIPTION
  27
  28 The B<vos create> command creates a read/write volume with the name
  29 specified by the B<-name> argument at the site specified by the B<-server>
  30 and B<-partition> arguments. In addition, the command allocates or sets
  31 the following:
  32
  33 =over 4
  34
  35 =item *
  36
  37 Volume ID numbers for the read/write volume and its associated read-only
  38 and backup volumes (this command does not actually create the latter two
  39 types of volume). A volume ID number is an identification number
  40 guaranteed to be unique within a cell.
  41
  42 =item *
  43
  44 An access control list (ACL) associated with the volume's root directory,
  45 which takes the same name as volume's mount point when the volume is
  46 mounted with the B<fs mkmount> command. An entry that grants all seven
  47 permissions to the members of the system:administrators group is
  48 automatically placed on the ACL. (In addition, the File Server by default
  49 always implicitly grants the C<l> (lookup) and C<a> (administer)
  50 permissions on every ACL to members of the system:administrators group,
  51 even when the group does not appear on an ACL; use the B<-implicit>
  52 argument to the B<fileserver> initialization command to alter the set of
  53 rights on a server-by-server basis if desired.)
  54
  55 =item *
  56
  57 The volume's space quota, set to 5000 kilobyte blocks by default. Use the
  58 B<-maxquota> argument to specify a different quota, or use the B<fs
  59 setquota> command to change the volume's quota after mounting the volume
  60 with the B<fs mkmount> command.
  61
  62 =back
  63
  64 The volume is empty when created. To access it via the Cache Manager,
  65 mount it in the file space by using the B<fs mkmount> command.
  66
  67 =head1 CAUTIONS
  68
  69 =include fragments/volsize-caution.pod
  70
  71 =head1 OPTIONS
  72
  73 =over 4
  74
  75 =item B<-server> <I<server name>>
  76
  77 Identifies the file server machine on which to create the read/write
  78 volume. Provide the machine's IP address or its host name (either fully
  79 qualified or using an unambiguous abbreviation). For details, see
  80 L<vos(1)>.
  81
  82 =item B<-partition> <I<partition name>>
  83
  84 Identifies the partition on which to create the read/write volume, on the
  85 file server machine specified by the B<-server> argument.  Provide the
  86 partition's complete name with preceding slash (for example, C</vicepa>)
  87 or use one of the three acceptable abbreviated forms. For details, see
  88 L<vos(1)>.
  89
  90 =item B<-name> <I<volume name>>
  91
  92 Specifies a name for the read/write volume. The maximum length is 22
  93 characters, which can include any alphanumeric or punctuation
  94 character. By convention, periods separate the fields in a name.  Do not
  95 apply the C<.backup> or C<.readonly> extension to a read/write volume
  96 name; they are reserved for the Volume Server to add to the read/write
  97 name when creating those backup and read-only volumes respectively.
  98
  99 =item B<-maxquota> <I<initial quota>>
 100
 101 Specifies the maximum amount of disk space the volume can use.  The size
 102 should be a positive integer followed by an optional suffix: C<K> for
 103 kibibytes (1024 bytes, the default), C<M> for mebibytes (1024 kibibytes),
 104 C<G> for gibibytes (1024 mebibytes), and C<T> for tebibytes (1024
 105 gibibytes).  The value C<0> (zero) grants an unlimited quota, but the size
 106 of the disk partition that houses the volume places an absolute limit on
 107 its size.  If this argument is omitted, the default value is C<5000K>.
 108
 109 =item B<-id> <I<volume ID>>
 110
 111 Specifies the volume ID for the read/write volume. If this options is not
 112 specified, or the given volume ID is 0, a volume ID will be allocated for
 113 the volume automatically. The volume IDs allocated should be fine for
 114 almost all cases, so you should almost never need to specify this option.
 115
 116 =item B<-roid> <I<readonly volume ID>>
 117
 118 Specifies the volume ID for the readonly volume corresponding to the
 119 read/write volume that is being created. The readonly volume will not be
 120 created; this merely specifies what volume ID the readonly volume will use
 121 when it is created. If a volume ID of 0 is specified here, no readonly
 122 volume ID will be assigned to the created volume immediately. A readonly
 123 volume ID can still be assigned later when B<vos addsite> is run; if a
 124 volume does not have a readonly volume ID associated with it by the time
 125 B<vos release> is run, a volume ID will be allocated for it.
 126
 127 If this option is not specified, the default readonly volume ID is one
 128 number higher than the read-write volume ID, whether or not that ID was
 129 manually specified.
 130
 131 As with the B<-id> option, the default allocated volume IDs should be
 132 sufficient for almost all cases, so you should almost never need to
 133 specify them explicitly. This option is available in OpenAFS
 134 versions 1.5.61 or later.
 135
 136 =item B<-cell> <I<cell name>>
 137
 138 Names the cell in which to run the command. Do not combine this argument
 139 with the B<-localauth> flag. For more details, see L<vos(1)>.
 140
 141 =item B<-noauth>
 142
 143 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 144 combine this flag with the B<-localauth> flag. For more details, see
 145 L<vos(1)>.
 146
 147 =item B<-localauth>
 148
 149 Constructs a server ticket using a key from the local
 150 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 151 to the Volume Server and Volume Location Server during mutual
 152 authentication. Do not combine this flag with the B<-cell> argument or
 153 B<-noauth> flag. For more details, see L<vos(1)>.
 154
 155 =item B<-verbose>
 156
 157 Produces on the standard output stream a detailed trace of the command's
 158 execution. If this argument is omitted, only warnings and error messages
 159 appear.
 160
 161 =item B<-encrypt>
 162
 163 Encrypts the command so that the operation's results are not transmitted
 164 across the network in clear text. This option is available in OpenAFS
 165 versions 1.4.11 or later and 1.5.60 or later.
 166
 167 =item B<-noresolve>
 168
 169 Shows all servers as IP addresses instead of the DNS name. This is very
 170 useful when the server address is registered as 127.0.0.1 or when dealing
 171 with multi-homed servers. This option is available in OpenAFS
 172 versions 1.4.8 or later and 1.5.35 or later.
 173
 174 =item B<-help>
 175
 176 Prints the online help for this command. All other valid options are
 177 ignored.
 178
 179 =back
 180
 181 =head1 OUTPUT
 182
 183 The Volume Server produces the following message to confirm that it
 184 created the volume:
 185
 186    Volume <volume_ID> created on partition <partition_name> of <machine_name>
 187
 188 =head1 EXAMPLES
 189
 190 The following command creates the read/write volume C<user.pat> on the
 191 F</vicepf> partition of the file server machine C<fs4.example.com>.
 192
 193    % vos create -server fs4.example.com -partition /vicepf -name user.pat
 194    Volume user.pat created on partition /vicepf of fs4.example.com
 195
 196 =head1 PRIVILEGE REQUIRED
 197
 198 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 199 machine specified with the B<-server> argument and on each database server
 200 machine. If the B<-localauth> flag is included, the issuer must instead be
 201 logged on to a server machine as the local superuser C<root>.
 202
 203 =head1 SEE ALSO
 204
 205 L<vos(1)>
 206
 207 =head1 COPYRIGHT
 208
 209 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 210
 211 This documentation is covered by the IBM Public License Version 1.0.  It was
 212 converted from HTML to POD by software written by Chas Williams and Russ
 213 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.