Syntax help: sys volmgt --help

The sys volmgt command is used to query and extend disk volumes on the system.

The following provides the command line syntax for this command:

[admin@server4889aads ~]$ sys volmgt --help
 
Syntax:
    --help,                  -h
    --hhelp,                 -hh
    --version,               -v
    --status,                -st
    --summary,               -s
    --monitor  [tail|less],  -m [tail|less]
    --logs,                  -l
    --scan
    --extend <volume> [ <n>m | <n>g | <n>t --remaining ]
  --extend --all
    --reset

[admin@server4889aads ~]$

Verbose help: sys volmgt --hhelp

The verbose help information for the scripts provides more information about what the tool is used for.

[admin@server4889aads ~]$ sys volmgt --hhelp
 
This script provides for the ability to extend the sizes of volumes on this
system. In order for a volume to be extended in size, the disk that hosts
the volume must first be increased in size using the tools that are used
to manage deployed virtual machines (VMware).
 
The following example illustrates how to add 20 GiB of storage to the
application log volume (/var/log/Avaya). This volume is located on the second
disk of the system and so this example assumes that disk 2 has been increased
in size by 20 GiB.
 
    sys volmgt --extend /var/log/Avaya 20g
 
The above example will do two things:
 
    1) It will extend the size of the LVM logical volume by 20 GiB.
 
    2) It will then extend the size of the Linux file system that is
       located inside that volume to the new size of the LVM logical
       volume.
 
Step (2) above may take several minutes to complete for larger volumes. If,
for some reason, this second operation is interrupted, it can be re-run
using the same command, but WITHOUT specifying the size argument. For example,
the following command is used to perform step (2) only for the application
log volume (/var/log/Avaya).
 
    sys volmgt --extend /var/log/Avaya
 
If in doubt as to whether or not all file systems have been fully extended in
their respective volumes, step (2) can be executed across all volumes using
a single command as follows:
 
    sys volmgt --extend --all
 
Performing step (2) on a file system that is already fully extended in its
LVM volume is a null operation (does no harm).
 
Note the following general points regarding this script:
 
- The extending of a volume cannot be undone. Make sure the correct volume
  is being extended, and by the correct size. To confirm any extend
  operation, the user is required to enter the response "confirm"
  (case insensitive).
 
- In order to avoid impacting system performance, avoid performing extend
  operations during periods of high traffic.
 
- Extend operations are performed by a background process, in order to
  avoid interference due to loss of an SSH connection. Avoid powering down
  or rebooting a server while there is a background operation in progress.
  The presence of a running background operation can be queried as follows:
 
    sys volmgt --status
 
- Logical volumes on the system are referenced using their Linux file system
  mount points, such as /var/log/Avaya and /media/data, with the exception
  of the volume containing Linux swap, which has no mount point. The Linux
  swap volume is referenced using "swap".
 
- Sizes are specified in base 2 units rather than base 10 (SI) units. For
  example, 1g = 1 GiB = 1024 x 1024 x 1024 bytes.
 
- Summary information is displayed in GiB, with a resolution of two decimal
  places. When extending the sizes of LVM volumes, units can be specified
  in mebibytes (m), gibibytes (g), or tebibytes (t).
 
- Due to file system overhead allocation by the Linux kernel, the size
  of a file system will never exactly match the size as reported by
  the LVM volume that contains that file system. To be certain that a file
  system is fully extended to the size of the volume that contains it,
  inspect the log file after issuing the extend operation as follows:
 
      sys volmgt --monitor less
 
  To perform such a check across all volumes:
 
      sys volmgt --extend --all
      sys volmgt --monitor less
 
The following arguments are supported by this script:
 
    --help, -h
        Terse help.
 
    --hhelp, -hh
        Verbose help (this help).
 
    --version, -v
        Prints the version of this script to stdout.
 
    --status, -st
        Prints the current status of this tool. Use this to determine
        if there is a background operation in progress, or the results
        of the last background operation.
 
    --summary, -s
        Prints a summary of disks, the LVM volumes contained on each disk,
        and the file system contained in each LVM volume. Disk information
        includes the size of the disk and the amount of free space
        available for allocation to volumes on the disk. LVM volume
        information includes the size of the LVM volume. File system
        information includes the size of the Linux file system and the
        current amount of space that is in use on that file system.
 
        Due to file system overhead allocation by the Linux kernel, the
        size of a file system will never exactly match the size as reported
        by the LVM volume that contains that file system. Refer to the top of
        this help information for more information.
 
    --monitor [tail|less]
    -m        [tail|less]
        Browse the log file for the latest extend operation. Specify "tail"
        to use the tail browser. Specify "less" to use the less
        browser, which allows scrolling and searching through the log file.
        If neither is specified, the browser defaults to the tail browser.
 
    --logs
        Generate a zip file in the current working directory that contains
        all logs generated to date by this script.
 
    --scan
        Scan disks for newly available storage. Do this after increasing
        the disk size of one of more disks. Once scanned, the newly
        available space appears in the "Free" column in the "--summary"
        output, and is now available for allocation to volumes on that disk.
 
        A summary is printed after the scan to show the updated volume
        information.
 
    --extend <volume> [ <n>m | <n>g | <n>t --remaining ]--extend --all
        The first form of the command operates on a single volume. If a size
        is specified, then the LVM volume is extended by that size (step 1),
        and the file system it contains is extended to use the new space
        made available in that volume (step 2). If a size is not specfied,
        then the file system contained in that volume is extended (i.e.,
        step 2 only).
 
        The "--all" form of the command is used to perform step 2 across
        all volumes on the system.
 
        For more information, see the examples at the top of this help.
 
        If "--remaining" is specified for the size, then the specified
        volume is extended with all remaining free space on that disk.
        If a specific increment is provided, then the volume is extended
        by that amount, reducing the amount of free space on the disk
        by that amount. Specific sizes are in the form of a number
        (e.g., "10", "10.5", or ".5") and a unit. Units are "m" for
        mebibites, "g" for gibibytes", and "t" for tebibytes".
 
        The smallest increment that can be specified is 100 MiB.
 
        Example invocations:
 
            sys volmgt --extend /var/log/Avaya 10g
            sys volmgt --extend /var/log/Avaya 10.5g
            sys volmgt --extend /var/log/Avaya 0.5g
            sys volmgt --extend /var/log/Avaya .5g
            sys volmgt --extend /var/log/Avaya 500m
            sys volmgt --extend /var/log/Avaya --remaining
            sys volmgt --extend /var/log/Avaya

  --reset
        Resets internal tracking data. Use this if this script is blocked
        on an invalid background progress indication. This condition can
        arise if a background operation was prematurely terminated due to,
        for example, a system reboot. Verify that no background operations
        are in progress prior to executing this command, through verification
        of the process id as reported by the "--status" argument.
 
[admin@server4889aads ~]$

Partitioning examples: sys volmgt --summary

Avaya Aura® Device Services supports partitioning versions 1.0 and 2.0.

The following example shows a summary of the information provided by this command for a version 1.0 partitioned system:

[admin@server4889aads ~]$ sys volmgt --summary
 
                           Disk and Volume Summary
 
+----------- Disk ------------+------------------- Volume --------------------+
|                             |                      LVM        File System   |
| Num  Name     Size     Free |    Name              Size      Size     Usage |
+-----------------------------+-----------------------------------------------+
|  2   sdb      25.00    0.00 | /home                4.00      3.94      1.49 |
|                             | /opt/Avaya          21.00     20.67      1.27 |
+-----------------------------+-----------------------------------------------+
|  3   sdc      10.00    0.00 | /media/data         10.00      9.84      0.15 |
+-----------------------------+-----------------------------------------------+

The following example shows a summary of the information provided by this command for a version 2.0 partitioned system:

[admin@server4950aads ~]$ sys volmgt -s
 
                           Disk and Volume Summary
 
+----------- Disk ------------+------------------- Volume --------------------+
|                             |                      LVM        File System   |
| Num  Name     Size     Free |    Name              Size      Size     Usage |
+-----------------------------+-----------------------------------------------+
|  1   sda     124.51   50.10 | /                   17.30     17.29      1.56 |
|                             | /home                4.00      3.99      0.03 |
|                             | /opt/Avaya          14.70     14.69      2.04 |
|                             | /tmp                14.90     14.89      0.63 |
|                             | /var                 8.50      8.49      0.09 |
|                             | /var/log             5.00      4.99      0.03 |
|                             | /var/log/audit       6.00      5.99      0.03 |
|                             | swap                 4.00       n/a       n/a |
+-----------------------------+-----------------------------------------------+
|  2   sdb      70.00    0.00 | /var/log/Avaya      70.00     69.98      0.11 |
+-----------------------------+-----------------------------------------------+
|  3   sdc      40.00    0.00 | /media/data         40.00     39.99      0.55 |
+-----------------------------+-----------------------------------------------+
|  4   sdd      10.00    0.00 | /media/cassandra    10.00      9.99      0.03 |
+-----------------------------+-----------------------------------------------+