System License Commands
System License Commands
Description
This command adds a license to a cluster. To add a license you must specify a valid license key, which you can
obtain from your sales representative.
Parameters
-license-code <License Code V2>,… - License Code V2
This parameter specifies the key of the license that is to be added to the cluster. The parameter accepts a
list of 28 digit upper-case alphanumeric character keys.
Examples
The following example adds a list of licenses with the keys AAAAAAAAAAAAAAAAAAAAAAAAAAAA and
BBBBBBBBBBBBBBBBBBBBBBBBBBBB to the cluster
The following example installs the licenses from the local node "/mroot/etc/lic_file"
Description
This command manages licenses in the cluster that have no effect, and so can be removed. Licenses that
have expired or are not affiliated with any controller in the cluster are deleted by this command. Licenses that
cannot be deleted are displayed with reasons for the non-deletion.
1
Parameters
[-unused <true>] - Remove unused licenses
If you use this parameter, the command removes licenses in the cluster that are not affiliated with any
controller in the cluster.
Examples
The following example simulates and displays the licenses that can be cleaned up:
2
cluster-1::> system license clean-up -expired -unused
3
Availability: This command is available to cluster administrators at the admin privilege level.
Description
This command deletes a license from a cluster.
Parameters
-serial-number <text> - Serial Number
This parameter specifies the serial number of the license that is to be deleted from the cluster. If this
parameter is not provided, the default value is the serial number of the cluster.
Examples
The following example deletes a license named CIFS and serial number 1-81-0000000000000000000123456
from the cluster:
The following example deletes from the cluster all of the licenses under the installed-license Core Bundle for
serial number 123456789:
Description
This command displays the status of all ONTAP aggregates.
Parameters
{ [-fields <fieldname>,…]
If you specify the -fields <fieldname>, … parameter, the command output also includes the specified
field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information about all fields.
4
[-node {<nodename>|local}] - Node
If you use this parameter, the command displays information only about aggregates that match the given
node.
Examples
The following example displays the license status of the cluster:
5
aggr2 (mirror) 10GB 10GB 6/21/2018 20:00:00 lease-
up-to-date
node2
root1 (mirror) 0B 2GB - lease-
not-required
root2 0B 2GB - lease-
not-required
aggr1 (mirror) 20GB 20GB 6/21/2018 18:10:00 lease-
up-to-date
aggr2 10GB 10GB 6/21/2018 20:00:00 lease-
up-to-date
node3
root3 0B 2GB - lease-
not-required
root4 (mirror) 0B 2GB - lease-
not-required
aggr3 15GB 0B 6/21/2018 20:00:00
aggregate-deleted
aggr4 (mirror) 15GB 15GB 6/21/2018 12:00:00 lease-
expired
aggr5 (mirror) 15GB 15GB 6/21/2018 21:00:00 lease-
up-to-date
aggr6 15GB 15GB 6/21/2018 21:00:00 plex-
deleted
aggr7 15GB 14GB 6/21/2018 21:00:00
aggregate-license-size-decreased
aggr8 (mirror) 0B 14GB - lease-
missing
node4
root3 (mirror) 0B 2GB - lease-
not-required
root4 0B 2GB - lease-
not-required
aggr3 (mirror) 15GB 0B 6/21/2018 20:00:00
aggregate-deleted
aggr4 15GB 15GB 6/21/2018 12:00:00 lease-
expired
aggr5 15GB 15GB 6/21/2018 21:00:00 lease-
up-to-date
aggr6 (mirror) 15GB 0B 6/21/2018 21:00:00 plex-
deleted
aggr7 (mirror) 15GB 14GB 6/21/2018 21:00:00
aggregate-license-size-decreased
aggr8 0B 14GB - lease-
missing
6
system license show-serial-numbers
Display History of Serial Numbers
Availability: This command is available to cluster administrators at the admin privilege level.
Description
This command displays the history of changes to the support and node serial numbers. The node serial
number and the support serial number of an ONTAP system are generally the same and do not change over
time. However, when capacity pools licensing is used, the support serial number is that of the capacity pool
license serial number and the node serial number is generated by the license manager. Also, when a cluster is
upgraded or converted from capacity tiers licensing to capacity pools licensing, its support serial numbers as
well as its node serial numbers change.
Parameters
{ [-fields <fieldname>,…]
If you specify the -fields <fieldname>, … parameter, the command output also includes the specified
field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information about all fields.
Examples
The following example displays the serial number change history of a four node capacity pools cluster. Its two
HA pairs were originally assigned to capacity pools 390000101 and 390000102, and then both were
reassigned to another capacity pool 390000103:
7
cluster1::> system license show-serial-numbers
The following example displays the history of a four node cluster converted from capacity tiers licensing to
capacity pools licensing:
The following example displays the history of an evaluation cluster that was upgraded to capacity pools
licensing:
8
cluster1::> system license show-serial-numbers
Description
This command displays the status of all Data ONTAP licenses.
Parameters
{ [-fields <fieldname>,…]
If you specify the -fields <fieldname>, … parameter, the command output also includes the specified
field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information about all fields.
[-status {not-compliant|eval|partially-installed|valid|not-installed|not-
applicable|not-known}] - Current State
If you use this parameter, the command displays information only about licenses that match the given
status.
9
license.
Examples
The following example displays the license status of the cluster:
10
system license show
Display licenses
Availability: This command is available to cluster administrators at the admin privilege level.
Description
The ` system license show ` command displays the information about licenses in the system.
Parameters
{ [-fields <fieldname>,…]
If you specify the -fields <fieldname>, … parameter, the command output also includes the specified
field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information about all fields.
11
[-host-id <text>] - Host Id
If you use this parameter, the command displays information only about the license that have the host id
you specify.
Examples
The following example displays information about all licensed packages in the cluster:
12
Description
The ` system license update-leases` command attempts to update (that is, renew) any capacity pool leases
that have expired.
Parameters
[-node {<nodename>|local}] - Nodes to Attempt Renewal
This optional parameter directs the system to update leases for only the specified nodes.
Examples
The following example updates all leases on a node:
Description
This command is deprecated and may be removed in a future release of Data ONTAP. Use the
"system license show-status " command.
The system license capacity show command displays the information about the licenses in the system
that are specifically related to storage capacity limits.
Parameters
{ [-fields <fieldname>,…]
If you specify the -fields <fieldname>, … parameter, the command output also includes the specified
field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information about all fields.
13
[-package <Licensable Package>] - Package
If you use this parameter, the command displays information only about the package you specify.
Examples
The following example displays information about all capacity-related licensed packages in the cluster, for a
hypothetical cluster of four nodes:
Note that for some nodes below, the maximum capacity is displayed as "-" (meaning "unlimited"). This happens
when there is no capacity license for the node - the node is operating with a limited-time temporary capacity
license.
14
cluster1::> system license capacity show
Node: node1
Serial Number: 1-81-0000000000001234567890123456
Max Current
Package Capacity Capacity Expiration
------------------------ -------- -------- -------------------
Select 2TB 15.81GB 4/11/2016 00:00:00
Node: node2
Serial Number: 1-81-0000000000000000000123456788
Max Current
Package Capacity Capacity Expiration
------------------------ -------- -------- -------------------
Select - 10.40TB 4/11/2016 00:00:00
Node: node3
Serial Number: 1-81-0000000000000000000123456789
Max Current
Package Capacity Capacity Expiration
------------------------ -------- -------- -------------------
Select - 10.40TB 4/11/2016 00:00:00
Node: node4
Serial Number: 1-81-0000000000001234567890123456
Max Current
Package Capacity Capacity Expiration
------------------------ -------- -------- -------------------
Select 2TB 15.81GB 4/11/2016 00:00:00
Related Links
• system license show-status
Description
This command displays information about license entitlement risk of the cluster for each license package. The
command displays license package name, entitlement risk, corrective action to reduce the entitlement risk for
each package, and the names and serial numbers for the nodes that do not have a node-locked license for a
given package. If command is used with the "-detail" parameter, the output displays the names and serial
numbers for all nodes in the cluster instead of only the nodes missing a node-locked license. It also displays
whether each node has a license and if the features corresponding to the package are used in the past week.
License entitlement risk does not apply to base license. If a node has a site or a valid demo license for the
15
given package, the entitlement risk will be shown as "medium" and the nodes missing a node-locked license
will be displayed. The corrective action, if the cluster has a site license for the given package is, "Verify all
controllers are entitled". If the entitlement risk is high, the corrective action is "Acquire node-locked license".
For the low entitlement risk and if the cluster is unlicensed for a given package, the corrective action is "None".
If the license entitlement risk cannot be computed because of infrastructure issues, the entitlement risk is
shown as "unknown" and the corrective action is displayed as "Verify system health".For more information
regarding license entitlement risk, see + http://mysupport.netapp.com/licensing/ontapentitlementriskstatus
Parameters
{ [-fields <fieldname>,…]
With this parameter, you can specify which fields should be displayed by the command. License package
names and node serial numbers are always displayed.
| [-detail ]
If you use this parameter, the command displays the license package name, entitlement risk, corrective
action, all nodes' names, their serial numbers, whether a node-locked license is present and whether a
given license package has been in use in the past week for each node in the cluster.
| [-instance ] }
If this parameter is used, the command displays values for all fields for each license package and each
node in the cluster individually.
16
[-missing-serial-numbers <text>,…] - Serial Numbers Missing a Node-Locked License
If you use this parameter, the command displays the packages for which the node with the specified serial
number does not have a node-locked license.
[-action-code {acquire-license|adjust-capacity|verify-entitlement|verify-system-
health|none}] - Corrective Action Code
If you use this parameter, the command displays information only for the license packages which need
specified corrective action code to reduce entitlement risk. This parameter is same as the parameter
"action".
Examples
The following example displays the information for license package NFS. NFS is unlicensed in the cluster and
no action is necessary to reduce the entitlement risk. The nodes, cluster1-01 and cluster-02, are missing a
node-locked license. The serial numbers for both nodes are also displayed.
The following example displays the information for license package CIFS. The cluster has high entitlement risk
for CIFS. The command displays serial numbers for all nodes in the cluster. Both nodes are missing a node-
locked CIFS license. Node with serial number 1-81-0000000000000004073806282 has used CIFS feature in
the past week, and the node with serial number 1-81-0000000000000004073806283 has not used this feature
in the past week.
17
system license license-manager check
Display license manager status
Availability: This command is available to cluster administrators at the advanced privilege level.
Description
The ` system license license-manager check ` checks the connectivity status of a node to the License Manager
that the node was configured to use. The status of a node might indicate that the License Manager is
inaccessible. If so, the status message contains additional text in parentheses. The text options and
descriptions are as follows:
Parameters
{ [-fields <fieldname>,…]
If you specify the -fields <fieldname>, … parameter, the command output also includes the specified
field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information about all fields.
Examples
The following examples check the status of the configured License Manager, before and after its license has
expired:
18
cluster1::*> system license license-manager check -node node1
Node: node1
LM status: License Manager (1.2.3.4:5678) is accessible.
Node Status
--------------- ------------------------------------------------------
node1 License Manager (1.2.3.4:5678) is accessible.
node2 License Manager (1.2.3.4:5678) is accessible.
2 entries were displayed.
cluster1::*> system license license-manager check -node node1
Node: node1
LM status: License Manager (1.2.3.4:5678) is inaccessible
(license_expired).
Node Status
--------------- ------------------------------------------------------
node1 License Manager (1.2.3.4:5678) is inaccessible
(license_expired).
node2 License Manager (1.2.3.4:5678) is inaccessible
(license_expired).
2 entries were displayed.
Description
The ` system license license-manager modify ` command modifies the configuration information for the License
Manager the system is using.
Parameters
[-host <text>] - License Manager Host (privilege: advanced)
Sets the specified host, which can either be a fully qualified domain name (FQDN) or an IP address.
Examples
The following example modifies information about the License Manager configuration:
19
cluster1::*> system license license-manager modify -host
myhost.mycompany.com
Description
The ` system license license-manager show ` command displays the information about the current License
Manager configuration.
Examples
The following example displays information about current License Manager configuration:
Description
This command is deprecated and may be removed in a future release of Data ONTAP. Use the
"system license show-status " command.
This command displays the list of licensable packages in the system and their current licensing status.
Parameters
{ [-fields <fieldname>,…]
If you specify the -fields <fieldname>, … parameter, the command output also includes the specified
field or fields. You can use '-fields ?' to display the fields to specify.
| [-instance ] }
If you specify the -instance parameter, the command displays detailed information about all fields.
20
[-package <Licensable Package>] - Package Name
If you use this parameter, the command displays information only about the specified package.
Examples
The following example displays the license status of the cluster:
21
cluster1::> system license status show
Package Licensed Method Expiration Status Details
----------------- --------------- --------------------
----------------------
Base site - -
NFS site - -
CIFS demo 12/7/2015 00:00:00 Demo expires on
given date
iSCSI none - -
FCP none - -
SnapRestore none - -
SnapMirror none - -
FlexClone none - -
SnapVault none - -
SnapLock none - -
SnapManagerSuite none - -
SnapProtectApps none - -
V_StorageAttach none - -
SnapLock_Enterprise
none - -
Insight_Balance none - -
OCShift none - -
Cloud subscr 12/15/2015 00:00:00 Subscription
expires on given date
17 entries were displayed.
Related Links
• system license show-status
22
Copyright information
Copyright © 2024 NetApp, Inc. All Rights Reserved. Printed in the U.S. No part of this document covered by
copyright may be reproduced in any form or by any means—graphic, electronic, or mechanical, including
photocopying, recording, taping, or storage in an electronic retrieval system—without prior written permission
of the copyright owner.
Software derived from copyrighted NetApp material is subject to the following license and disclaimer:
THIS SOFTWARE IS PROVIDED BY NETAPP “AS IS” AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENT SHALL
NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
NetApp reserves the right to change any products described herein at any time, and without notice. NetApp
assumes no responsibility or liability arising from the use of products described herein, except as expressly
agreed to in writing by NetApp. The use or purchase of this product does not convey a license under any
patent rights, trademark rights, or any other intellectual property rights of NetApp.
The product described in this manual may be protected by one or more U.S. patents, foreign patents, or
pending applications.
LIMITED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to restrictions as set
forth in subparagraph (b)(3) of the Rights in Technical Data -Noncommercial Items at DFARS 252.227-7013
(FEB 2014) and FAR 52.227-19 (DEC 2007).
Data contained herein pertains to a commercial product and/or commercial service (as defined in FAR 2.101)
and is proprietary to NetApp, Inc. All NetApp technical data and computer software provided under this
Agreement is commercial in nature and developed solely at private expense. The U.S. Government has a non-
exclusive, non-transferrable, nonsublicensable, worldwide, limited irrevocable license to use the Data only in
connection with and in support of the U.S. Government contract under which the Data was delivered. Except
as provided herein, the Data may not be used, disclosed, reproduced, modified, performed, or displayed
without the prior written approval of NetApp, Inc. United States Government license rights for the Department
of Defense are limited to those rights identified in DFARS clause 252.227-7015(b) (FEB 2014).
Trademark information
NETAPP, the NETAPP logo, and the marks listed at http://www.netapp.com/TM are trademarks of NetApp, Inc.
Other company and product names may be trademarks of their respective owners.
23