Creates a volume. Permissions required:
cv or fc on the volume
maprcli volume create -name <volume name> [ -advisoryquota <advisory quota> ] [ -ae <accounting entity> ] [ -aetype <accounting entity type> ] [ -allowgrant true|false ] [ -allowinherit true|false ] [ -auditenabled true|false ] [ -cluster <cluster> ] [ -coalesce interval in mins ] [ -createparent 0|1 ] [ -group <list of group:allowMask> ] [ -inherit <volume name> ] [ -localvolumehost <localvolumehost> ] [ -localvolumeport <localvolumeport> ] [ -maxinodesalarmthreshold <maxinodesalarmthreshold> ] [ -minreplication <minimum replication factor> ] [ -mirrorschedule <mirror schedule ID> ] (4.0.2 only) [ -mount 0|1 ] [ -nsminreplication <minimum replication factor> ] [ -nsreplication <replication factor> ] [ -path <mount path> ] [ -quota <quota> ] [ -readonly <read-only status> ] [ -replication <replication factor> ] [ -replicationtype <type> ] [ -rereplicationtimeoutsec <seconds> ] [ -rootdirperms <root directory permissions> ] [ -schedule <ID> ] [ -source <source> ] [ -topology <topology> ] [ -type rw|mirror] (4.0.2) or [-type 0|1] (4.0.1) [ -user <list of user:allowMask> ]
The advisory quota for the volume as
The accounting entity that owns the volume.
The type of accounting entity:
Specifies whether a parent volume grants permission for a child volume to inherit its properties. True or false.
Specifies whether a new volume inherit sproperties from the parent mount point volume. True or false. Default: true.
Specifies whether to turn auditing on for the volume. If auditing is also enabled at the cluster level with the
You must have the
The cluster on which to create the volume.
The interval of time during which READ, WRITE, or GETATTR operations on one file from one client IP address are logged only once, if auditing is enabled.
For example, suppose that a client application reads a single file three times in 6 minutes, so that there is one read at 0 minutes, another at 3 minutes, and a final read at 6 minutes. If the coalesce interval is at least 6 minutes, then only the first read operation is logged. However, if the interval is between 4 minutes, then only the first and third read operations are logged. If the interval is 2 minutes, all three read operations are logged.
The default value is 60 minutes. Setting this field to a larger number helps prevent audit logs from growing quickly.
Specifies whether or not to create a parent directory to hold the volume link:
Space-separated list of
|inherit||Specifies the name of the volume from which the new volume will inherit properties. When |
The local volume host.
The local volume port. Default: 5660
Threshold for the INODES_EXCEEDED alarm.
The minimum replication level. Default: 2 When the replication factor falls below this minimum, re-replication occurs as aggressively as possible to restore the replication level. If any containers in the CLDB volume fall below the minimum replication factor, writes are disabled until aggressive re-replication restores the minimum level of replication.
|mirrorschedule||The ID of a mirror schedule. If a mirror schedule ID is provided, then the mirror volume will automatically sync with its source volume on the specified schedule.|
Specifies whether the volume is mounted at creation time.
The name of the volume to create.
|nsminreplication||The minimum replication level for the namespace container. Default: 2 When the replication factor falls below this minimum, re-replication occurs as aggressively as possible to restore the replication level. If any containers in the CLDB volume fall below the minimum replication factor, writes are disabled until aggressive re-replication restores the minimum level of replication. When enabled, the CLDB manages the namespace container replication separate from the data container replication. This capability is used when you have low volume replication but want to have higher namespace replication. Note: This parameter must be the same or larger than the equivalent data replication parameter, |
The desired namespace container replication level. Default: 3. When the number of copies falls below the desired replication factor, but remains equal to or above the minimum replication factor, re-replication occurs after the timeout specified in the
The path at which to mount the volume.
The quota for the volume as
Do not use two-letter abbreviations for quota units, such as
Specifies whether or not the volume is read-only:
The desired replication level. Default: 3 When the number of copies falls below the desired replication factor, but remains equal to or above the minimum replication factor, re-replication occurs after the timeout specified in the
The desired replication type. You can specify
Timeout (in seconds) before attempting re-replication of replica containers. This volume property defines the timeout period until CLDB starts re-replicating the containers on the node of the volume when CLDB stops receiving a heartbeat from the node.
When a node is down, CLDB gives the node an hour to come back online before it takes any action for the containers on this node. This parameter can be set on volumes to reduce the default 1 hour to a shorter time period. This option is provided mainly for local volumes, repl=1 so that when an mfs is down, CLDB can give up quickly and decide that the container has no master. This forces the TT to give up on local containers and take appropriate recovery action of deleting the mapred volume and creating another one.
Permissions on the volume root directory.
The ID of a schedule. Use the schedule list command to find the ID of the named schedule you want to apply to the volume.
In 4.0.1, if a schedule ID is provided, it applies to a mirror volume. The mirror volume will automatically sync with its source volume on the specified schedule. Use the schedule list command to find the ID of the named schedule you wish to apply to the volume.
In 4.0.2 and later releases, if a schedule ID is provided, it applies to either a mirror volume or a standard volume. A standard volume will automatically create snapshots on the specified schedule. A mirror volume will sync with its source volume on the specified schedule. If a mirror volume is made into a standard volume, the
For mirror volumes, the source volume to mirror, in the format
The rack path to the volume.
The type of volume to create.
For 4.0.2 and later releases, these values are accepted:
For 4.0.1 and earlier releases, these values are accepted:
Space-separated list of
Create the volume "test-volume" mounted at "/test/test-volume"
maprcli volume create -name test-volume -path /test/test-volume -type rw
Create Volume with a Quota and an Advisory Quota
This example creates a volume with the following parameters:
- advisoryquota: 100M
- name: volumename
- path: /volumepath
- quota: 500M
- replication: 3
- schedule: 2
- topology: /East Coast
- type: rw
maprcli volume create -name volumename -path /volumepath -advisoryquota 100M -quota 500M -replication 3 -schedule 2 -topology "/East Coast" -type rw
Create the mirror volume "test-volume.mirror" from source volume "test-volume" and mount at "/test/test-volume-mirror"
maprcli volume create -name test-volume.mirror -source test-volume@src-cluster-name -path /test/test-volume-mirror -type mirror
Create volumes that inherit from a parent volume
When creating and mounting a volume, the location of the mount path is specified by the path parameter. Volumes can be mounted via the web console, the
maprcli commands, or the REST commands. The
maprcli commands include
volume create -path command and the
mapcli volume mount -path command if the volume was previously created. Sub-volumes (children) can inherit properties from their parent volume.
In the following example, a parent volume and two (2) child volumes are create where the child volume inherit properties from the parent. When the
inherit flag is explicitly used, the
allowgrant parameter for the parent volume is not required.
- For child volumes, c1 and c2, inheritance is explicit because the
inheritoption is specified. Thus, p1.c1 and p1.c2 volumes will inherit all properties from volume p1 (note that p1 is not a parent of p1.c1) regardless of whether the
allowgrantoption is set on p1 or not. In this case, there is an explicit inheritance ant the
allowgrantflag is ignored and volume properties are inherited.
- For the child volume, c3, inheritance is implicit. Meaning, the child volume, p1.c3, inherits all properties from the parent volume, p1, only if the
allowgrantoption is set on p1.
In the following example, the p1.child volume normally inherits from the p1 parent volume properties because p1.child is mounted under p1 and
allowgrant option is set to true on the parent volume. However, if the child volume doesn't want to inherit properties, then set the
allowinherit option to false (default: true).
Create a volume with namespace container replicas