Module netapp_ontap.resources.license_package

Copyright © 2022 NetApp Inc. All rights reserved.

Overview

Licensing allows you to tailor a system to meet an organization's specific needs. You can enable new features by purchasing a license from a NetApp sales associate. After installation of the license, the new feature is available immediately.

This interface manages licenses according to their supported feature. By default, the interface displays packages with installed licenses, but you can also return unlicensed packages.

Each feature has a compliance state that is indicated at the package level. Individual licenses also contain a compliance state indicated in the "licenses" array. The state of the package is determined by analyzing the underlying licenses according to the following criteria:

  • Licensing terms
  • Cluster state

Licensing terms

The licensing terms define the conditions under which a package is considered "compliant". Individual licenses are evaluated based on the following:

  • Scope
  • Time period
  • Usage

Scope

A package can be licensed under the following scopes:

  • Site - Permits the feature to be used by any node in any cluster.
  • Cluster - Permits the feature to be used by any node in a single specific cluster.
  • Node - Permits the authorized node to use the feature. Within a cluster, if you don't supply every node with a valid license, the package state indicates "noncompliant". You must purchase a license for each node in a cluster for the package to be considered "compliant".

Time period

Some package licenses are only valid for a limited period of time. After a license has expired, the package state changes to "noncompliant". You need to purchase a new license for the package to return to a "compliant" state.

Usage

Some package licenses have additional terms that need to be maintained to keep a license in compliance. These conditions are defined by the individual license. For example, a license might define the maximum amount of storage that a node can allocate for the license to be "compliant".

Cluster state

A cluster's state consists of the following:

  • Node online status
  • Node cluster membership

Some features require that a node be online to display a valid compliance state. If a node cannot be reached or is not known to the cluster, the individual license might indicate an "unknown" state.


Licensing keys

A license is issued in one of the following three formats:

  • 28-character key
  • NetApp License File Version 1 (NLFv1)
  • NetApp License File Version 2 (NLFv2)

Overview of NLFv1 and NLFv2 License Formats

NLFv1 and NLFv2 licenses are both JSON based files that allow features to be enabled.

The difference between the two formats is that a NLFv2 license allows multiple features to be enabled with a single file. A NLFv1 license is capable of enabling a single feature.

These licenses are identified, in the various methods, as follows:

Format Identifying Keys
28 Character Key name / serial_number
NLFv1 name / serial_number
NLFv2 licenses.installed_license / serial_number
###
The following is an example of a 28-character key:
####
AMEPOSOIKLKGEEEEDGNDEKSJDEEE

The following is an example of an NLFv1 key:

{
  "statusResp": {
  "version": "1",
  "serialNumber": "123456789",
  "message": "Success",
  "licenses": {
    "capacity": "1",
    "type": "capacity",
    "licenseProtocol": "FABRICPOOL-TB",
    "package": "FabricPool",
    "licenseScope": "cluster"
  },
  "snStatus": "Active",
  "product": "fabricpool",
  "statusCode": "S007"
  },
  "Signature": "signatureABC"
}

The following is an example of an NLFv2 key:

{
  "statusResp": {
  "version": "2",
  "serialNumber": "123456789",
  "message": "Success",
  "product": "Sample NLFv2 License",
  "licenses": {
    "capacity": "1",
    "type": "capacity",
    "HostID": "5554444",
    "package": [ "NFS", "CIFS" ],
    "licenseScope": "node"
  },
  "snStatus": "Active",
  "statusCode": "S007"
  },
  "Signature": "signatureABC"
}

You can use this API to submit any format to enable features.


Examples

Retrieving a collection of licenses organized by package

This example retrieves a collection that contains one entry for each package (filtered to only the 'fabricpool' package).

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(LicensePackage.get_collection(fields="*", name="fabricpool")))

[
    LicensePackage(
        {
            "scope": "cluster",
            "licenses": [
                {
                    "owner": "testcluster-1",
                    "capacity": {"maximum_size": 1099511627776, "used_size": 0},
                    "serial_number": "4149027342",
                }
            ],
            "state": "compliant",
            "name": "fabricpool",
            "_links": {"self": {"href": "/api/cluster/licensing/licenses/fabricpool"}},
        }
    )
]

Retrieving a collection of licenses installed with NLFv2

This example retrieves a collection of licenses that were installed by a NLFv2 formatted license.

Note: The license is referenced by the installed license "Core*Bundle" and the license serial number "4149026-97-8"

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            LicensePackage.get_collection(
                fields="*",
                serial_number="4149026-97-8",
                **{"licenses.installed_license": "Core*Bundle"}
            )
        )
    )

[
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim2",
                    "active": False,
                    "compliance": {"state": "unlicensed"},
                },
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim1",
                    "active": True,
                    "capacity": {"maximum_size": 10995116277760},
                    "host_id": "4149026-97-8",
                    "compliance": {"state": "compliant"},
                    "installed_license": "Core Bundle",
                    "serial_number": "4149026-97-8",
                },
            ],
            "state": "noncompliant",
            "name": "nfs",
            "_links": {
                "self": {
                    "href": "/api/cluster/licensing/licenses/nfs/?licenses.installed_license=Core*Bundle"
                }
            },
        }
    ),
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim2",
                    "active": False,
                    "compliance": {"state": "unlicensed"},
                },
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim1",
                    "active": True,
                    "capacity": {"maximum_size": 10995116277760},
                    "host_id": "4149026-97-8",
                    "compliance": {"state": "compliant"},
                    "installed_license": "Core Bundle",
                    "serial_number": "4149026-97-8",
                },
            ],
            "state": "noncompliant",
            "name": "cifs",
            "_links": {
                "self": {
                    "href": "/api/cluster/licensing/licenses/cifs/?licenses.installed_license=Core*Bundle"
                }
            },
        }
    ),
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim2",
                    "active": False,
                    "compliance": {"state": "unlicensed"},
                },
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim1",
                    "active": True,
                    "capacity": {"maximum_size": 10995116277760},
                    "host_id": "4149026-97-8",
                    "compliance": {"state": "compliant"},
                    "installed_license": "Core Bundle",
                    "serial_number": "4149026-97-8",
                },
            ],
            "state": "noncompliant",
            "name": "iscsi",
            "_links": {
                "self": {
                    "href": "/api/cluster/licensing/licenses/iscsi/?licenses.installed_license=Core*Bundle"
                }
            },
        }
    ),
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim2",
                    "active": False,
                    "compliance": {"state": "unlicensed"},
                },
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim1",
                    "active": True,
                    "capacity": {"maximum_size": 10995116277760},
                    "host_id": "4149026-97-8",
                    "compliance": {"state": "compliant"},
                    "installed_license": "Core Bundle",
                    "serial_number": "4149026-97-8",
                },
            ],
            "state": "noncompliant",
            "name": "snaprestore",
            "_links": {
                "self": {
                    "href": "/api/cluster/licensing/licenses/snaprestore/?licenses.installed_license=Core*Bundle"
                }
            },
        }
    ),
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim2",
                    "active": False,
                    "compliance": {"state": "unlicensed"},
                },
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim1",
                    "active": True,
                    "capacity": {"maximum_size": 10995116277760},
                    "host_id": "4149026-97-8",
                    "compliance": {"state": "compliant"},
                    "installed_license": "Core Bundle",
                    "serial_number": "4149026-97-8",
                },
            ],
            "state": "noncompliant",
            "name": "flexclone",
            "_links": {
                "self": {
                    "href": "/api/cluster/licensing/licenses/flexclone/?licenses.installed_license=Core*Bundle"
                }
            },
        }
    ),
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim2",
                    "active": False,
                    "compliance": {"state": "unlicensed"},
                },
                {
                    "evaluation": False,
                    "owner": "hbrock-vsim1",
                    "active": True,
                    "capacity": {"maximum_size": 10995116277760},
                    "host_id": "4149026-97-8",
                    "compliance": {"state": "compliant"},
                    "installed_license": "Core Bundle",
                    "serial_number": "4149026-97-8",
                },
            ],
            "state": "noncompliant",
            "name": "s3",
            "_links": {
                "self": {
                    "href": "/api/cluster/licensing/licenses/s3/?licenses.installed_license=Core*Bundle"
                }
            },
        }
    ),
]

Retrieving a collection of installed licenses

This example retrieves a collection containing all packages (except base) that have installed licenses.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(LicensePackage.get_collection(fields="*", name="!base")))

[
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "owner": "testcluster-1",
                    "serial_number": "1-81-0000000000000004149027492",
                }
            ],
            "state": "compliant",
            "name": "nfs",
            "_links": {"self": {"href": "/api/cluster/licensing/licenses/nfs"}},
        }
    ),
    LicensePackage(
        {
            "scope": "node",
            "licenses": [
                {
                    "owner": "testcluster-1",
                    "serial_number": "1-81-0000000000000004149027492",
                }
            ],
            "state": "compliant",
            "name": "cifs",
            "_links": {"self": {"href": "/api/cluster/licensing/licenses/cifs"}},
        }
    ),
]

Retrieving a collection of unlicensed packages

By default, unlicensed packages are filtered from the collection output. This example shows how to use a query to retrieve unlicensed packages.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(LicensePackage.get_collection(name="flexcache", state="unlicensed")))

[
    LicensePackage(
        {
            "name": "flexcache",
            "_links": {"self": {"href": "/api/cluster/licensing/licenses/flexcache"}},
        }
    )
]

Installing a NLF license

This example installs a single NLFv1 license. A NLFv2 license installs using the same procedure.

Note: You must escape all the double quotes and backslash characters of the JSON license before it can be placed in the POST request.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = LicensePackage()
    resource.post(hydrate=True)
    print(resource)

Installing a 28-character key

This example installs a single 28-character key formatted license.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = LicensePackage()
    resource.post(hydrate=True)
    print(resource)

Installing multiple licenses with one API call

This example shows how multiple keys can be provided to install multiple features in a single API call.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = LicensePackage()
    resource.post(hydrate=True)
    print(resource)

Retrieving information for a specific license package

This example shows how to retrieve information about the specific feature package fabricpool.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = LicensePackage(name="fabricpool")
    resource.get()
    print(resource)

LicensePackage(
    {
        "scope": "cluster",
        "licenses": [
            {
                "owner": "testcluster-1",
                "capacity": {"maximum_size": 109951162777600, "used_size": 0},
                "serial_number": "123456789",
            }
        ],
        "state": "compliant",
        "name": "fabricpool",
        "_links": {"self": {"href": "/api/cluster/licensing/licenses/fabricpool/"}},
    }
)

Deleting a specific license

This example show how to delete a CIFS site license.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = LicensePackage(name="cifs")
    resource.delete(serial_number="1-80-000011")

Deleting with a query

The following example shows how to delete all NFS licenses specified with the '*' query.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = LicensePackage(name="nfs")
    resource.delete(serial_number="*")

Deleting all licenses installed with NLFv2

The following example shows how to delete all licenses installed by a NLFv2 formatted license.

from netapp_ontap import HostConnection
from netapp_ontap.resources import LicensePackage

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = LicensePackage()
    resource.delete(
        serial_number="4149026-97-8", **{"licenses.installed_license": "Core*Bundle"}
    )

Classes

class LicensePackage (*args, **kwargs)

Allows interaction with LicensePackage objects on the host

Initialize the instance of the resource.

Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

MyResource(name='foo').name == 'foo'

Args

*args
Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs
each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

Ancestors

Static methods

def count_collection(*args, connection: HostConnection = None, **kwargs) -> int

Fetch a count of all objects of this type from the host.

This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

Returns

On success, returns an integer count of the objects of this type. On failure, returns -1.

Raises

NetAppRestError: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

def delete_collection(*args, records: Iterable[_ForwardRef('LicensePackage')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Deletes a license.

  • system license delete

Learn more


Delete all objects in a collection which match the given query.

All records on the host which match the query will be deleted.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
records
Can be provided in place of a query. If so, this list of objects will be deleted from the host.
body
The body of the delete request. This could be a Resource instance or a dictionary object.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be deleted.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def find(*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves a collection of license packages.

Note: By default, the GET method only returns licensed packages. You must provide the following query "state=unlicensed" to retrieve unlicensed packages.

  • system license show-status
  • system license show

Learn more


Find an instance of an object on the host given a query.

The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A Resource object containing the details of the object or None if no matches were found.

Raises

NetAppRestError: If the API call returned more than 1 matching resource.

def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]

Retrieves a collection of license packages.

Note: By default, the GET method only returns licensed packages. You must provide the following query "state=unlicensed" to retrieve unlicensed packages.

  • system license show-status
  • system license show

Learn more


Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

Args

*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records
The maximum number of records to return per call
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

def post_collection(records: Iterable[_ForwardRef('LicensePackage')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, connection: HostConnection = None, **kwargs) -> Union[List[LicensePackage], NetAppResponse]

Installs one or more feature licenses.

Required properties

  • keys - Array containing a list of NLF or 28-character license keys.
  • system license add

Learn more


Send this collection of objects to the host as a creation request.

Args

records
A list of Resource objects to send to the server to be created.
*args
Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to create a bar for a particular foo, the foo.name value should be passed.
hydrate
If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of each object. When hydrate is set to True, poll must also be set to True.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
connection
The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A list of Resource objects matching the provided
type which have been created by the host and returned. This is _not_
 
the same list that was provided, so to continue using the object, you
 

should save this list. If poll is set to False, then a NetAppResponse object is returned instead.

Raises

NetAppRestError: If the API call returned a status code >= 400

Methods

def delete(self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

Deletes a license.

  • system license delete

Learn more


Send a deletion request to the host for this object.

Args

body
The body of the delete request. This could be a Resource instance or a dictionary object.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
Any key/value pairs passed will be sent as query parameters to the host.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def get(self, **kwargs) -> NetAppResponse

Retrieves a specific license package.

Note: By default, the GET method only returns licensed packages. You must provide the following query "state=unlicensed" to retrieve unlicensed packages.

  • system license show
  • system license show-status

Learn more


Fetch the details of the object from the host.

Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def post(self, hydrate: bool = False, poll: bool = True, poll_interval: Union[int, NoneType] = None, poll_timeout: Union[int, NoneType] = None, **kwargs) -> NetAppResponse

Installs one or more feature licenses.

Required properties

  • keys - Array containing a list of NLF or 28-character license keys.
  • system license add

Learn more


Send this object to the host as a creation request.

Args

hydrate
If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll
If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval
If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout
If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs
Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Inherited members

class LicensePackageSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)

The fields of the LicensePackage object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC

Class variables

keys POST

The keys field of the license_package.

licenses GET

Installed licenses of the package.

The links field of the license_package.

name GET

Name of the license.

Example: NFS

scope GET

Scope of the license.

Valid choices:

  • not_available
  • site
  • cluster
  • node
state GET

Summary state of package based on all installed licenses.

Valid choices:

  • compliant
  • noncompliant
  • unlicensed
  • unknown