Module netapp_ontap.resources.capacity_lease

Copyright © 2022 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

Overview

A pool-based license, such as capacity pool, is installed on a license manager instance and its entitlement is shared by multiple ONTAP nodes and clusters. Each ONTAP node or cluster needs to acquire a lease, an ephemeral entitlement, to enable and operate the feature and resources that require the license.
A lease is valid for a limited duration, which is configurable on the license manager instance, and is automatically renewed to keep it current as long as the feature is enabled and/or the resource exists.
In case of capacity pools licensing, a capacity lease is required from the associated capacity pool when a data aggregate is created.


Examples

Retrieving a collection of leases

# API
GET /api/cluster/licensing/leases
# Response
200 OK
# JSON Body
{
  "records":[
    {
      "id":"390000100-4ea7a442-86d1-11e0-ae1c-123478563401",
      "serial_number":"390000101"
      "pool":{
        "serial_number":"390000101"
      },
      "aggregate":{
        "uuid":"4ea7a442-86d1-11e0-ae1c-123478563401",
        "name":"node_1_aggr_1"
      },
      "capacity":1099511627776,
      "start_time":"2019-02-02T19:00:00Z",
      "expiry_time":"2019-02-03T19:00:00Z",
      "_links":{
        "self":{
          "href":"/api/cluster/licensing/leases/390000100-4ea7a442-86d1-11e0-ae1c-123478563401"
        }
      }
    },
    {
      "serial_number":"390000102"
      "id":"390000100-4ea7a442-86d1-11e0-ae1c-123478563402",
      "pool":{
        "serial_number":"390000102"
      },
      "aggregate":{
        "uuid":"4ea7a442-86d1-11e0-ae1c-123478563402",
        "name":"node_3_aggr_2"
      },
      "capacity":1099511627776,
      "start_time":"2019-02-02T19:00:00Z",
      "expiry_time":"2019-02-03T19:00:00Z",
      "_links":{
        "self":{
          "href":"/api/cluster/licensing/leases/390000100-4ea7a442-86d1-11e0-ae1c-123478563402"
        }
      }
    }
  ],
  "num_records":2,
  "_links":{
    "self":{
      "href":"/api/cluster/licensing/leases"
    }
  }
}

Retrieving a specific lease

# API
GET /api/cluster/licensing/leases/390000100-4ea7a442-86d1-11e0-ae1c-123478563401
# Response
200 OK
# JSON Body
{
  "id":"390000100-4ea7a442-86d1-11e0-ae1c-123478563401",
  "serial_number":"390000101"
  "pool":{
    "serial_number":"390000101"
  },
  "aggregate":{
    "uuid":"4ea7a442-86d1-11e0-ae1c-123478563401",
    "name":"node_1_aggr_1"
  },
  "capacity":1099511627776,
  "start_time":"2019-02-02T19:00:00Z",
  "expiry_time":"2019-02-03T19:00:00Z",
  "_links":{
    "self":{
      "href":"/api/cluster/licensing/leases/390000100/4ea7a442-86d1-11e0-ae1c-123478563401"
    }
  }
}

Classes

class CapacityLease (*args, **kwargs)

An ephemeral entitlement to use a storage aggregate. A lease on storage capacity is automatically renewed as long as the aggregate exists.

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 find(*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves a collection of leases.

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 leases.

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.

Methods

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

Retrieves a lease.

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

Inherited members

class CapacityLeaseSchema (*, 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 CapacityLease object

Ancestors

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

Class variables

aggregate: Aggregate GET POST PATCH

The aggregate field of the capacity_lease.

capacity: Size GET

Amount of capacity, in bytes, which this lease entitles the storage aggregate to use.

Example: 1099511627776

expiry_time: ImpreciseDateTime GET

Date and time when this lease expires.

Example: 2019-02-02T19:00:00Z

id: str GET

Identifier for the lease record.

Example: 390000100-4ea7a442-86d1-11e0-ae1c-112233445566

The links field of the capacity_lease.

pool: CapacityPool GET POST PATCH

The pool field of the capacity_lease.

start_time: ImpreciseDateTime GET

Date and time when this lease was acquired.

Example: 2019-02-03T19:00:00Z