APIs in Category: license | 7-Mode API version 1.20

license-add license-delete license-list-info

NetApp Manage ONTAP

license-add | [top]

> Enable license for a Data ONTAP service. This API is deprecated in Data ONTAP 7-Mode 8.2 and later, and will return EAPINOTIMPLEMENTED. Use license-v2-add instead.

> Input Name | Range | Type | Description
> code |  | string | license code of a Data ONTAP service to be enabled.

> Errno | Description
> EINVAL |  |

license-delete | [top]

> Disable license for a Data ONTAP service. This API is deprecated in Data ONTAP 7-Mode 8.2 and later, and will return EAPINOTIMPLEMENTED. Use license-v2-delete instead.

> Input Name | Range | Type | Description
> service |  | string | Name of the Data ONTAP service to be disabled.

> Errno | Description
> EINVAL |  |

license-list-info | [top]

> Returns information about the current list of licensed Data ONTAP services, their codes, the type of license, and, if it is a time limited license, the expiration date. It also tells the services that are not licensed for your appliance, or if a time limited licensed service has expired. This API is deprecated in Data ONTAP 7-Mode 8.2 and later, and will return EAPINOTIMPLEMENTED. Use license-v2-list-info instead.

> Input Name | Range | Type | Description
> hide-code |  | boolean optional | If true, prevents the code field from being output Default value is false.
> Output Name | Range | Type | Description
> licenses |  | license-info[] | An array, one entry per each licensable service.

> Vfiler-enabled
> Yes

Element definition: license-info | [top]

> Information about a single licensable service.

> Name | Range | Type | Description
> code |  | string optional | license code of the service. This information is returned only if "is-licensed" is true or "is-expired" is true. For features that are enabled automatically due to platform based business policies, the code value returned is "ENABLED". For more details see the description for the is-auto-enabled element below.
> count |  | integer | number of times a promotional license code has been installed. 0 for non-promotional licenses.
> expiration-timestamp |  | integer optional | expected expiration timestamp in seconds since January 1, 1970, if it's a promotional/time-expiring license. 0 for all other licenses.
> installation-timestamp |  | integer optional | installation timestamp of the service license code in seconds since January 1, 1970. A value of 0 is returned if there is no installation timestamp, but there is a valid code. This is probably an error, or corruption.
> is-auto-enabled |  | boolean | "true" if is-licensed is true because this feature was automatically enabled based on the platform type and current business packaging policies. The code element will also return "ENABLED". In all other cases this will return false.
> is-demo |  | boolean | "true" if the license is a promotional/time-expiring/demo license, "false" otherwise.
> is-expired |  | boolean | "true" if the promotional/time-expiring/demo license has expired, "false" otherwise.
> is-licensed |  | boolean | "true" if the service is licensed and has not expired, "false" otherwise.
> is-site |  | boolean | "true" if the license is a site license, "false" otherwise.
> length |  | integer optional | length of the promotional/time-expiring license in days. 0 for non-promotional licenses.
> node-count |  | integer optional | number of nodes for which the license is valid.
> package-list |  | package-master[] optional | List of package master feature names for the the packages to which this feature belongs. Returned if this feature is a member of at least one package on the current platform.
> platform |  | string optional | indicates the type of the platform for which the license is valid. Possible values are : filer and netcache, gateway, nearstore, and simulator.
> service |  | string | name of the service.
> storage-count |  | integer optional | number of terabytes allowed if it's a Gateway platform ("gateway_storage") license.

Element definition: package-master | [top]

> The license name of the feature that is considered to be the master of the package.

> [none]