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