APIs in Category: license-v2 | Cluster-Mode API version 1.20

license-v2-add license-v2-cleanup-list-info license-v2-delete license-v2-delete-expired license-v2-delete-unused license-v2-list-info license-v2-status-list-info | This set of zapis allows management of 7-Mode and Cluster-Mode licenses for Data ONTAP 8.2 and later. License keys are controller based which requires a separate license for each controller. A typical license key has a serial number embedded in it that restrict its use on a specific controller only (with the exception of Site and Demo keys). In a cluster, a single license with an associated serial number can allow a package to be used in the cluster, but to be fully entitled for a package, one must install a license for each controller. Site and Demo licenses are cluster wide and only require a single license for the entire cluster.

NetApp Manage ONTAP

license-v2-add | [top]

> Add license for a Data ONTAP service.

> Input Name | Range | Type | Description
> codes |  | license-code-v2[] | Data ONTAP Cluster-Mode service/feature. 24 or 48 uppercase alpha only characters.
> Output Name | Range | Type | Description
> license-v2-failure-list |  | license-v2-result[] optional | A list of failed license operations, one entry per license.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

license-v2-cleanup-list-info | [top]

> Returns licenses that can be cleaned up. A license can be cleaned up if it's a demo license and its expiration time has passed (expired), or if it is a license for a controller that is no longer part of a cluster (unused). One can use the cleanup apis to remove these licenses together, or alternatively, they can use the standard license-remove api to remove them one at a time.

> Output Name | Range | Type | Description
> licenses |  | license-v2-cleanup[] optional | An array, one entry per each license.

> Errno | Description
> EINTERNALERROR |  |

license-v2-delete | [top]

> Removes license for a Data ONTAP service.

> Input Name | Range | Type | Description
> package |  | licensed-package | Package Possible values: "base" - Cluster Base License, "nfs" - NFS License, "cifs" - CIFS License, "iscsi" - iSCSI License, "fcp" - FCP License, "cdmi" - CDMI License, "snaprestore" - SnapRestore License, "snapmirror" - SnapMirror License, "flexclone" - FlexClone License, "snapvault" - SnapVault License, "snaplock" - SnapLock License, "snapmanagersuite" - SnapManagerSuite License, "snapprotectapps" - SnapProtectApp License, "v_storageattach" - Virtual Attached Storage License
> serial-number |  | node-serial-number optional | Serial number of the node associated with the license. If this parameter is not provided, the default serial number used is the cluster serial number.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

license-v2-delete-expired | [top]

> Remove licenses that have expired in the cluster.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

license-v2-delete-unused | [top]

> Remove licenses that have no controller affiliation in the cluster.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

license-v2-list-info | [top]

> Returns infomation for DATA ONTAP licenses.

> Output Name | Range | Type | Description
> licenses |  | license-v2-info[] | An array, one entry per license.

> Errno | Description
> EINTERNALERROR |  |

license-v2-status-list-info | [top]

> Returns license status information for cluster mode packages.

> Output Name | Range | Type | Description
> license-v2-status |  | license-v2-status-info[] | An array, one entry per each licensable service.

> Errno | Description
> EINTERNALERROR |  |

Element definition: license-code-v2 | [top]

> License Code V2

> [none]

Element definition: license-v2-cleanup | [top]

> Status information about a licensable package. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> owner |  | string optional | Name of the controller associated with the license. Attributes: non-creatable, non-modifiable
> package |  | licensed-package optional | Name of the licensed package. Attributes: key, non-creatable, non-modifiable Possible values: "base" - Cluster Base License, "nfs" - NFS License, "cifs" - CIFS License, "iscsi" - iSCSI License, "fcp" - FCP License, "cdmi" - CDMI License, "snaprestore" - SnapRestore License, "snapmirror" - SnapMirror License, "flexclone" - FlexClone License, "snapvault" - SnapVault License, "snaplock" - SnapLock License, "snapmanagersuite" - SnapManagerSuite License, "snapprotectapps" - SnapProtectApp License, "v_storageattach" - Virtual Attached Storage License
> reason |  | string optional | The reason the license can be cleaned up. Attributes: non-creatable, non-modifiable
> serial-number |  | node-serial-number optional | Serial number of the controller or cluster. Attributes: key, non-creatable, non-modifiable

Element definition: license-v2-info | [top]

> Information about a licensable package. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> customer-id |  | string optional | Customer Identification. This field is used to track site licenses issued to Enterprise Level Agreement customers. It will typical be set to "none" unless a unique customer id has been assigned. This value is reported in Auto Support, and can be used to correlate licensing information with backend business systems for tracking purposes. Attributes: non-creatable, non-modifiable
> description |  | string optional | Description of the licensed package. Attributes: non-creatable, non-modifiable
> expiration-time |  | datetime optional | License expiration time. Attributes: non-creatable, non-modifiable
> legacy |  | boolean optional | Legacy License. A legacy license indicates that the license was previously installed prior to this release. Returns true if the license was installed prior to this release and false otherwise.
> owner |  | string optional | Controller or Cluster that owns the serial number. Attributes: non-creatable, non-modifiable
> package |  | licensed-package optional | Name of the licensed package. Attributes: key, required-for-create, non-modifiable Possible values: "base" - Cluster Base License, "nfs" - NFS License, "cifs" - CIFS License, "iscsi" - iSCSI License, "fcp" - FCP License, "cdmi" - CDMI License, "snaprestore" - SnapRestore License, "snapmirror" - SnapMirror License, "flexclone" - FlexClone License, "snapvault" - SnapVault License, "snaplock" - SnapLock License, "snapmanagersuite" - SnapManagerSuite License, "snapprotectapps" - SnapProtectApp License, "v_storageattach" - Virtual Attached Storage License
> serial-number |  | node-serial-number optional | Serial number of the controller or cluster. The license serial-number is reported in Auto Support also and can be used to correlate controller or cluster wide licensing information. Attributes: key, required-for-create, non-modifiable
> type |  | license-v2-type optional | License type. Attributes: non-creatable, non-modifiable Possible values: "license" , "site" , "demo"

Element definition: license-v2-result | [top]

> License operation result When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> description |  | string optional | Additional information of the failure. Attributes: non-creatable, non-modifiable
> entry |  | license-code-v2 optional | Failed license entry. Attributes: non-creatable, non-modifiable
> errcode |  | license-v2-op-status optional | Failure error code. Attributes: non-creatable, non-modifiable

Element definition: license-v2-status-info | [top]

> Status information about a licensable package. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> expiration-time |  | datetime optional | License expiration date. Attributes: non-creatable, non-modifiable
> method |  | licensed-method optional | Method in which a package is licensed in a cluster. Attributes: non-creatable, non-modifiable Possible values: "none" - None, "license" - License, "site" - Site, "demo" - Demo
> package |  | licensed-package optional | Name of the licensed package. Attributes: key, non-creatable, non-modifiable Possible values: "base" - Cluster Base License, "nfs" - NFS License, "cifs" - CIFS License, "iscsi" - iSCSI License, "fcp" - FCP License, "cdmi" - CDMI License, "snaprestore" - SnapRestore License, "snapmirror" - SnapMirror License, "flexclone" - FlexClone License, "snapvault" - SnapVault License, "snaplock" - SnapLock License, "snapmanagersuite" - SnapManagerSuite License, "snapprotectapps" - SnapProtectApp License, "v_storageattach" - Virtual Attached Storage License

Element definition: licensed-package | [top]

> Licensable Package Possible values: "base" - Cluster Base License, "nfs" - NFS License, "cifs" - CIFS License, "iscsi" - iSCSI License, "fcp" - FCP License, "cdmi" - CDMI License, "snaprestore" - SnapRestore License, "snapmirror" - SnapMirror License, "flexclone" - FlexClone License, "snapvault" - SnapVault License, "snaplock" - SnapLock Compliance License, "snapmanagersuite" - SnapManagerSuite License, "snapprotectapps" - SnapProtectApp License, "v_storageattach" - Virtual Attached Storage License, "snaplock_enterprise" - SnapLock Enterprise License, "insight_balance" - OnCommand Balance

> [none]

Element definition: node-serial-number | [top]

> Assigned Node serial-number

> [none]

Element definition: datetime | [top]

> The number of seconds since January 1, 1970. Range : [0..2^31-1].

> [none]

Element definition: license-code-v2 | [top]

> License Code V2

> [none]

Element definition: license-v2-op-status | [top]

> License Operation Status Possible values: "license_success" - Operation Completed Successfully, "license_invalid" - Failed: Invalid License Key, "license_expired" - Failed: License Expired, "license_notallowed" - Failed: Operation Not Allowed, "license_unavailable" - Failed: License NOT Available, "license_internal" - Failed: Internal Error, "license_err_unknown" - Failed: Unknown Error

> [none]

Element definition: license-v2-type | [top]

> This field indicates the type of a license. A typical license will be of "license" type, which indicates that it's associated with a specific controller. A "site" license is a special license provided under Enterprise Level Agreements. A "demo" license is a temporary license with an expiration time. It is usually issued for trial purposes only. Possible values: "license" , "site" , "demo"

> [none]

Element definition: licensed-method | [top]

> Licensed Method Possible values: "none" - None, "license" - License, "site" - Site, "demo" - Demo

> [none]