Module netapp_ontap.resources.quota_report
Copyright © 2019 NetApp Inc. All rights reserved.
Overview
Quota reports provide the current file and space consumption for a user, group, or qtree in a FlexVol or a FlexGroup volume.
Quota report APIs
The following APIs can be used to retrieve quota reports associated with a volume in ONTAP. – GET /api/storage/quota/reports – GET /api/storage/quota/reports/{volume_uuid}/{index}
Examples
Retrieving all the quota report records
This API is used to retrieve all the quota report records.
The following example shows how to retrieve quota report records for all FlexVols and FlexGroup volumes.
# The API:
GET /api/storage/quota/reports
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/quota/reports" -H 'accept: application/hal+json'
# The response:
{
"records": [
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "314a328f-502d-11e9-8771-005056a7f717",
"name": "fg",
"_links": {
"self": {
"href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717"
}
}
},
"index": 0,
"_links": {
"self": {
"href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/0"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "314a328f-502d-11e9-8771-005056a7f717",
"name": "fg",
"_links": {
"self": {
"href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717"
}
}
},
"index": 1152921504606846976,
"_links": {
"self": {
"href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/1152921504606846976"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "314a328f-502d-11e9-8771-005056a7f717",
"name": "fg",
"_links": {
"self": {
"href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717"
}
}
},
"index": 3458764513820540928,
"_links": {
"self": {
"href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/3458764513820540928"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "314a328f-502d-11e9-8771-005056a7f717",
"name": "fg",
"_links": {
"self": {
"href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717"
}
}
},
"index": 4611686018427387904,
"_links": {
"self": {
"href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/4611686018427387904"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "314a328f-502d-11e9-8771-005056a7f717",
"name": "fg",
"_links": {
"self": {
"href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717"
}
}
},
"index": 5764607523034234880,
"_links": {
"self": {
"href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/5764607523034234880"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 0,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/0"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 281474976710656,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/281474976710656"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 1152921504606846976,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/1152921504606846976"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 1153202979583557632,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/1153202979583557632"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 2305843013508661248,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/2305843013508661248"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 3458764513820540928,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/3458764513820540928"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 3459045988797251584,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/3459045988797251584"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 4611686018427387904,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/4611686018427387904"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 4611967493404098560,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/4611967493404098560"
}
}
},
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
}
},
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"index": 5764607523034234880,
"_links": {
"self": {
"href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/5764607523034234880"
}
}
}
],
"num_records": 15,
"_links": {
"self": {
"href": "/api/storage/quota/reports/"
}
}
}
Retrieving a specific quota report record
This API is used to retrieve a specific quota report record.
The following example shows how to retrieve a single quota report user record.
# The API:
GET /api/storage/quota/reports/{volume.uuid}/{index}
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/281474976710656" -H 'accept: application/hal+json'
# Response for quota report user record:
{
"svm": {
"uuid": "5093e722-248e-11e9-96ee-005056a7657c",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c"
}
}
},
"volume": {
"uuid": "cf480c37-2a6b-11e9-8513-005056a7657c",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c"
}
}
},
"index": 281474976710656,
"type": "user",
"users": [
{
"name": "fred",
"id" : "300008"
}
],
"qtree": {
"name": "qt1",
"id": 1,
"_links": {
"self": {
"href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1"
}
}
},
"space": {
"hard_limit": 41943040,
"soft_limit": 31457280,
"used": {
"total": 10567680,
"soft_limit_percent": 34,
"hard_limit_percent": 25
}
}
"files": {
"soft_limit": 30,
"hard_limit": 40,
"used": {
"total": 11,
"soft_limit_percent": 37,
"hard_limit_percent": 28
}
}
"_links": {
"self": {
"href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/281474976710656"
}
}
}
}
Retrieving a single quota report multi-user record
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/281474976710656" -H 'accept: application/hal+json'
# Response for quota report multi-user record:
{
"svm": {
"uuid": "5093e722-248e-11e9-96ee-005056a7657c",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c"
}
}
},
"volume": {
"uuid": "cf480c37-2a6b-11e9-8513-005056a7657c",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c"
}
}
},
"index": 1153484454560268288,
"type": "user",
"users": [
{
"name": "fred",
"id" : "300008"
},
{
"name": "john",
"id" : "300009"
},
{
"name": "smith",
"id" : "300010"
}
],
"qtree": {
"name": "qt1",
"id": 1,
"_links": {
"self": {
"href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1"
}
}
},
"space": {
"hard_limit": 41943040,
"soft_limit": 31457280,
"used": {
"total": 10567680,
"soft_limit_percent": 34,
"hard_limit_percent": 25
}
}
"files": {
"soft_limit": 30,
"hard_limit": 40,
"used": {
"total": 11,
"soft_limit_percent": 37,
"hard_limit_percent": 28
}
}
"_links": {
"self": {
"href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/1153484454560268288"
}
}
}
}
Retrieving a single quota report group record
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/3459045988797251584" -H 'accept: application/hal+json'
# Response for quota report group record:
{
"svm": {
"uuid": "5093e722-248e-11e9-96ee-005056a7657c",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c"
}
}
},
"volume": {
"uuid": "cf480c37-2a6b-11e9-8513-005056a7657c",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c"
}
}
},
"index": 3459045988797251584,
"type": "group",
"group": {
"name" : "test_group",
"id" : "500009"
},
"qtree": {
"name": "qt1",
"id": 1,
"_links": {
"self": {
"href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1"
}
}
},
"space": {
"hard_limit": 41943040,
"soft_limit": 31457280,
"used": {
"total": 10567680,
"soft_limit_percent": 34,
"hard_limit_percent": 25
}
}
"files": {
"soft_limit": 30,
"hard_limit": 40,
"used": {
"total": 11,
"soft_limit_percent": 37,
"hard_limit_percent": 28
}
}
"_links": {
"self": {
"href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/3459045988797251584"
}
}
}
}
Retrieving a single quota report tree record
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/4612248968380809216" -H 'accept: application/hal+json'
# Response for quota report tree record:
{
"svm": {
"uuid": "5093e722-248e-11e9-96ee-005056a7657c",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c"
}
}
},
"volume": {
"uuid": "cf480c37-2a6b-11e9-8513-005056a7657c",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c"
}
}
},
"index": 4612248968380809216,
"type": "tree",
"qtree": {
"name": "qt1",
"id": 1,
"_links": {
"self": {
"href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1"
}
}
},
"space": {
"hard_limit": 41943040,
"soft_limit": 31457280,
"used": {
"total": 10567680,
"soft_limit_percent": 34,
"hard_limit_percent": 25
}
}
"files": {
"soft_limit": 30,
"hard_limit": 40,
"used": {
"total": 11,
"soft_limit_percent": 37,
"hard_limit_percent": 28
}
}
"_links": {
"self": {
"href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/4612248968380809216"
}
}
}
}
Classes
class QuotaReport (*args, **kwargs)
-
Allows interaction with QuotaReport 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 find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves the quota report records for all FlexVols and FlexGroup volumes.
Related ONTAP commands
quota report
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 or 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.Raises
NetAppRestError
: If the API call did not return exactly 1 matching resource. def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable
-
Retrieves the quota report records for all FlexVols and FlexGroup volumes.
Related ONTAP commands
quota report
Learn more
Fetch a list of all objects of this type from the host.
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
objectsRaises
NetAppRestError
: If there is no connection available to use either passed in or on the library.
Methods
def get(self, **kwargs) -> NetAppResponse
-
Retrieves a specific quota report record.
Related ONTAP commands
quota report
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 QuotaReportSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the QuotaReport object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var files
-
The files field of the quota_report.
var group
-
The group field of the quota_report.
var index
-
Index that identifies a unique quota record. Valid in URL.
var links
-
The links field of the quota_report.
var opts
var qtree
-
The qtree field of the quota_report.
var space
-
The space field of the quota_report.
var specifier
-
Quota specifier
var svm
-
The svm field of the quota_report.
var type
-
Quota type associated with the quota record.
Valid choices:
- tree
- user
- group
var users
-
This parameter specifies the target user or users associated with the given quota report record. This parameter is available for user quota records and is not available for group or tree quota records. The target user or users are identified by a user name and user identifier. The user name can be a UNIX user name or a Windows user name, and the identifer can be a UNIX user identifier or a Windows security identifier.
var volume
-
The volume field of the quota_report.