doc/man-pages/pod1/vos_create.pod

   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>> >>> S<<< B<-partition> <I<partition name>> >>>
  11     S<<< B<-name> <I<volume name>> >>> S<<< [B<-maxquota> <I<initial quota (KB)>>] >>>
  12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-verbose>]
  13     [B<-help>]
  14
  15 B<vos cr> S<<< B<-s> <I<machine name>> >>> S<<< B<-p> <I<partition name>> >>>
  16     S<<< B<-na> <I<volume name>> >>> S<<< [B<-m> <I<initial quota (KB)>>] >>>
  17     S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-v>] [B<-h>]
  18
  19 =for html
  20 </div>
  21
  22 =head1 DESCRIPTION
  23
  24 The B<vos create> command creates a read/write volume with the name
  25 specified by the B<-name> argument at the site specified by the B<-server>
  26 and B<-partition> arguments. In addition, the command allocates or sets
  27 the following:
  28
  29 =over 4
  30
  31 =item *
  32
  33 Volume ID numbers for the read/write volume and its associated read-only
  34 and backup volumes (this command does not actually create the latter two
  35 types of volume). A volume ID number is an identification number
  36 guaranteed to be unique within a cell.
  37
  38 =item *
  39
  40 An access control list (ACL) associated with the volume's root directory,
  41 which takes the same name as volume's mount point when the volume is
  42 mounted with the B<fs mkmount> command. An entry that grants all seven
  43 permissions to the members of the system:administrators group is
  44 automatically placed on the ACL. (In addition, the File Server by default
  45 always implicitly grants the C<l> (lookup) and C<a> (administer)
  46 permissions on every ACL to members of the system:administrators group,
  47 even when the group does not appear on an ACL; use the B<-implicit>
  48 argument to the B<fileserver> initialization command to alter the set of
  49 rights on a server-by-server basis if desired.)
  50
  51 =item *
  52
  53 The volume's space quota, set to 5000 kilobyte blocks by default. Use the
  54 B<-maxquota> argument to specify a different quota, or use the B<fs
  55 setquota> command to change the volume's quota after mounting the volume
  56 with the B<fs mkmount> command.
  57
  58 =back
  59
  60 The volume is empty when created. To access it via the Cache Manager,
  61 mount it in the file space by using the B<fs mkmount> command.
  62
  63 =head1 CAUTIONS
  64
  65 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
  66
  67 =head1 OPTIONS
  68
  69 =over 4
  70
  71 =item B<-server> <I<server name>>
  72
  73 Identifies the file server machine on which to create the read/write
  74 volume. Provide the machine's IP address or its host name (either fully
  75 qualified or using an unambiguous abbreviation). For details, see
  76 L<vos(1)>.
  77
  78 =item B<-partition> <I<partition name>>
  79
  80 Identifies the partition on which to create the read/write volume, on the
  81 file server machine specified by the B<-server> argument.  Provide the
  82 partition's complete name with preceding slash (for example, C</vicepa>)
  83 or use one of the three acceptable abbreviated forms. For details, see
  84 L<vos(1)>.
  85
  86 =item B<-name> <I<volume name>>
  87
  88 Specifies a name for the read/write volume. The maximum length is 22
  89 characters, which can include any alphanumeric or punctuation
  90 character. By convention, periods separate the fields in a name.  Do not
  91 apply the C<.backup> or C<.readonly> extension to a read/write volume
  92 name; they are reserved for the Volume Server to add to the read/write
  93 name when creating those backup and read-only volumes respectively.
  94
  95 =item B<-maxquota> <I<volume quota>>
  96
  97 Specifies the maximum amount of disk space the volume can use, as a number
  98 of kilobyte blocks (a value of C<1024> is one megabyte). The value C<0>
  99 (zero) grants an unlimited quota, but the size of the disk partition that
 100 houses the volume places an absolute limit on its size.  If this argument
 101 is omitted, the default value is C<5000>.
 102
 103 =item B<-cell> <I<cell name>>
 104
 105 Names the cell in which to run the command. Do not combine this argument
 106 with the B<-localauth> flag. For more details, see L<vos(1)>.
 107
 108 =item B<-noauth>
 109
 110 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 111 combine this flag with the B<-localauth> flag. For more details, see
 112 L<vos(1)>.
 113
 114 =item B<-localauth>
 115
 116 Constructs a server ticket using a key from the local
 117 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 118 to the Volume Server and Volume Location Server during mutual
 119 authentication. Do not combine this flag with the B<-cell> argument or
 120 B<-noauth> flag. For more details, see L<vos(1)>.
 121
 122 =item B<-verbose>
 123
 124 Produces on the standard output stream a detailed trace of the command's
 125 execution. If this argument is omitted, only warnings and error messages
 126 appear.
 127
 128 =item B<-help>
 129
 130 Prints the online help for this command. All other valid options are
 131 ignored.
 132
 133 =back
 134
 135 =head1 OUTPUT
 136
 137 The Volume Server produces the following message to confirm that it
 138 created the volume:
 139
 140    Volume <volume_ID> created on partition <partition_name> of <machine_name>
 141
 142 =head1 EXAMPLES
 143
 144 The following command creates the read/write volume C<user.pat> on the
 145 F</vicepf> partition of the file server machine C<fs4.abc.com>.
 146
 147    % vos create -server fs4.abc.com -partition /vicepf -name user.pat
 148    Volume user.pat created on partition /vicepf of fs4.abc.com
 149
 150 =head1 PRIVILEGE REQUIRED
 151
 152 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 153 machine specified with the B<-server> argument and on each database server
 154 machine. If the B<-localauth> flag is included, the issuer must instead be
 155 logged on to a server machine as the local superuser C<root>.
 156
 157 =head1 SEE ALSO
 158
 159 L<vos(1)>
 160
 161 =head1 COPYRIGHT
 162
 163 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 164
 165 This documentation is covered by the IBM Public License Version 1.0.  It was
 166 converted from HTML to POD by software written by Chas Williams and Russ
 167 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.