mmlslicense command

Displays information about the IBM Storage Scale node licensing designation or about disk and cluster capacity.

Synopsis

mmlslicense [-Y] [-L | --capacity [--formatted] | --licensed-usage|--ilmt-data]

Availability

Available on all IBM Storage Scale editions.

Description

Use the mmlslicense command to display the number of IBM Storage Scale client and server licenses assigned to the nodes in the cluster.

For information on IBM Storage Scale license designation, See IBM Storage Scale license designation.

Parameters

-Y
Displays the command output in a parseable format with a colon (:) as a field delimiter. Each column is described by a header.
Note: Fields that have a colon (:) are encoded to prevent confusion. For the set of characters that might be encoded, see the command documentation of mmclidecode. Use the mmclidecode command to decode the field.
-L
Displays information about the license type that is associated with each of the nodes in the cluster. An asterisk after the license type indicates insufficient license level for the roles that the node performs.
--capacity [--formatted]
Displays disk and cluster size information.
--formatted
Formats numeric output by inserting thousands separators based on the current locale settings. This improves readability by grouping digits appropriately for the selected locale.
For example:
  • For en_IN (India) locale, the grouping appears as 1,07,37,41,82,400 Bytes (0.098 TiB).
  • For de_DE (Germany) locale, the grouping appears as 107.374.182.400 Bytes (0,098 TiB).
Note:
  • The --capacity parameter is not supported on the Windows operating system. Alternatively, you can use the wmic diskdrive get name,size command to list device sizes for the Windows operating system.
--licensed-usage
Displays the names and sizes of the NSDs, the total size of all the NSDs, and the licensed capacity limit. See Example 4. This option is valid only in the IBM Storage Scale Developer Edition.
Note:
  • The licensed capacity of the IBM Storage Scale Developer Edition is 12 TiB (13,194,139,533,312 bytes) of storage. The mmcrnsd command calculates the size of the current NSDs plus the size of the proposed new NSDs and fails with an error message if the licensed capacity would be exceeded. For more information, see the mmcrnsd command.
--ilmt-data
Writes the software identify information such as the product edition and the product ID into the /var/adm/ras/ILMT_Data.slmtag. This information is used by the IBM® License Metric Tool (ILMT). The option also writes the DECIMAL_TERABYTE metric into the log file. This metric represents the terabytes of storage capacity, in decimal number, for all the NSDs in the Cluster.
This option must be used independently and not with any other option, including the -Y option. It is valid only in the following editions:
  • IBM Storage Scale Erasure Code Edition
  • IBM Storage Scale Data Management Edition
  • IBM Storage Scale Data Access Edition

Exit status

0
Successful completion.
nonzero
A failure occurred.

Security

You must have root authority to run the mmlslicense command.

The node on which the command is issued must be able to execute remote shell commands on any other node in the cluster. The shell commands must be executed without the use of a password and must not produce any extraneous messages. For more information, see Requirements for administering a GPFS file system.

Examples

1. The following command displays summary information about the IBM Storage Scale licenses of the nodes in the cluster:
#mmlslicense 
Summary information 
---------------------
Number of nodes defined in the cluster:                          4
Number of nodes with server license designation:                 1
Number of nodes with client license designation:                 2
Number of nodes still requiring server license designation:      1
Number of nodes still requiring client license designation:      1
This node runs IBM Spectrum Scale Advanced Edition
2. The following command displays the types of IBM Storage Scale licenses that are associated with the nodes in the cluster:
#mmlslicense -L
Node name                    Required license   Designated license
-------------------------------------------------------------------
k145n05.kgn.ibm.com               server            server
k145n06.kgn.ibm.com               server            client  *
k145n07.kgn.ibm.com               client            client
k145n08.kgn.ibm.com               client            none    *

 Summary information 
---------------------
Number of nodes defined in the cluster:                          4
Number of nodes with server license designation:                 1
Number of nodes with client license designation:                 2
Number of nodes still requiring server license designation:      1
Number of nodes still requiring client license designation:      1
This node runs IBM Spectrum Scale Advanced Edition
3. The following command displays information for capacity-based licensing:
#mmlslicense --capacity --formatted
NSD Summary:
======================
Total Number of NSDs:               3   
nsd_vdb:                            4,398,046,511,104 Bytes (4.000 TiB)
nsd_vdc:                            4,398,046,511,104 Bytes (4.000 TiB)
nsd_vdd:                            4,398,046,511,104 Bytes (4.000 TiB)
Cluster Summary:
======================
Cluster Total Capacity:             13,194,139,533,312 Bytes (12.000 TiB)
4. The following command displays the names and sizes of the NSDs, the total size of all the NSDs, and the licensed capacity limit:
#mmlslicense --licensed-usage
 NSD Name                                  Size Bytes                  Size TiB
-----------------------------------------------------------------------------------
 nsd_vdb                                 32,212,254,720                  0.029
 nsd_vdc                                  2,147,483,648                  0.002
 nsd_vdd                                  2,147,483,648                  0.002


 Developer Edition Summary:                          Bytes                TiB
 ==================================================================================
 Total NSD Licensed Limit:              13,194,139,533,312                 12
 Total NSD Size:                            36,507,222,016              0.033
5. The following command displays disk capacities in an environment that contains vdisks:
# mmlslicense --capacity --formatted

 NSD Summary:
 ======================
  Total Number of NSDs:     4
  RG001LG001VS001:          165,078,070,460,416 Bytes (150.138 TiB)
  RG001LG002VS001:          165,078,070,460,416 Bytes (150.138 TiB)
  RG001LG003VS001:          165,078,070,460,416 Bytes (150.138 TiB)
  RG001LG004VS001:          165,078,070,460,416 Bytes (150.138 TiB)
 Cluster Summary:
 ======================
 Cluster Total Capacity:    660,312,281,841,664 Bytes (600.551 TiB)

See also

Location

/usr/lpp/mmfs/bin