summaryrefslogtreecommitdiffstats
path: root/commands/storage/doc
diff options
context:
space:
mode:
authorJan Safranek <jsafrane@redhat.com>2013-09-30 15:59:27 +0200
committerJan Safranek <jsafrane@redhat.com>2013-09-30 15:59:27 +0200
commit192dd2ab0132e20f00371585a925d947a4e25065 (patch)
tree5cf4f41304e5454e8de3c93117deecd605665297 /commands/storage/doc
parent1fa3b22471898af172378d9686a98d80723254c8 (diff)
downloadopenlmi-scripts-192dd2ab0132e20f00371585a925d947a4e25065.tar.gz
openlmi-scripts-192dd2ab0132e20f00371585a925d947a4e25065.tar.xz
openlmi-scripts-192dd2ab0132e20f00371585a925d947a4e25065.zip
Added overview of common command line options.
Diffstat (limited to 'commands/storage/doc')
-rw-r--r--commands/storage/doc/cmdline.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/commands/storage/doc/cmdline.rst b/commands/storage/doc/cmdline.rst
index 6c8666a..aebcc7c 100644
--- a/commands/storage/doc/cmdline.rst
+++ b/commands/storage/doc/cmdline.rst
@@ -3,4 +3,27 @@ LMI command line reference
These commands allow listing and manipulation with block devices.
+Common options
+--------------
+
+* `<device>` can be specified as one of:
+
+ * DeviceID of appropriate CIM_StorageExtent. This is internal OpenLMI ID of
+ the device and it should be stable across system reboots.
+
+ * Device name directly in /dev directory, such as `/dev/sda`. This device
+ name is available as `Name` property of CIM_StorageExtent.
+
+ * Name of MD RAID or logical volume. This method cannot be used when the
+ name is not unique, for example when there are two logical volumes with
+ the same name, allocated from different volume groups. This name is
+ available as `ElementName` property of CIM_StorageExtent.
+
+* `<vg>` represents name of a volume group, with or without `/dev/` prefix.
+
+* Any `<size>`, such as size of new partition or new logical volume, can
+ be specified with 'T', 'G', 'M' or 'K' suffix, which represents appropriate
+ unit (terabytes, gigabytes etc.) 1K (kilobyte) is 1024 of bytes.
+ The suffix is case insensitive, i.e. 1g = 1G.
+
.. include:: cmdline.generated