Module netapp_ontap.resources.qtree
Copyright © 2021 NetApp Inc. All rights reserved.
Overview
A qtree is a logically defined file system that can exist as a special subdirectory of the root directory within a FlexVol volume or a FlexGroup volume.
Qtree QoS policy
Qtree QoS policy and settings enforce Service Level Objectives (SLOs) on a qtree. SLOs can be set by specifying "qos_policy.max_throughput_iops" and/or "qos_policy.max_throughput_mbps" or "qos_policy.min_throughput_iops".
Specifying "min_throughput_iops" is only supported on volumes hosted on a node that is flash optimized. A pre-created QoS policy can also be used by specifying "qos_policy.name" or "qos_policy.uuid" properties.
Setting or assigning a QoS policy to a qtree is not supported if its containing volume or SVM has a QoS policy attached, or a file or LUN in its containing volume already has a QoS policy attached.
Qtree APIs
The following APIs are used to create, retrieve, modify, and delete qtrees.
- POST /api/storage/qtrees
- GET /api/storage/qtrees
- GET /api/storage/qtrees/{volume-uuid}/{qtree-id}
- PATCH /api/storage/qtrees/{volume-uuid}/{qtree-id}
- DELETE /api/storage/qtrees/{volume-uuid}/{qtree-id}
Examples
Creating a qtree inside a volume for an SVM
This API is used to create a qtree inside a volume for an SVM.
The following example shows how to create a qtree in a FlexVol volume with a given security style, user, group, UNIX permissions, an export policy, and a QoS policy.
from netapp_ontap import HostConnection
from netapp_ontap.resources import Qtree
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = Qtree()
resource.svm.name = "svm1"
resource.volume.name = "fv"
resource.name = "qt1"
resource.security_style = "unix"
resource.user.name = "unix_user1"
resource.group.name = "unix_group1"
resource.unix_permissions = 744
resource.export_policy.name = "default"
resource.qos_policy.max_throughput_iops = 1000
resource.post(hydrate=True)
print(resource)
Qtree(
{
"security_style": "unix",
"svm": {"name": "svm1"},
"user": {"name": "unix_user1"},
"group": {"name": "unix_group1"},
"qos_policy": {
"uuid": "39ac471f-ff35-11e9-b0f9-005056a7ab52",
"max_throughput_iops": 1000,
"min_throughput_iops": 0,
"max_throughput_mbps": 0,
"name": "vs0_auto_gen_policy_39a9522f_ff35_11e9_b0f9_005056a7ab52",
},
"export_policy": {"name": "default"},
"volume": {"name": "fv"},
"unix_permissions": 744,
"_links": {"self": {"href": "/api/storage/qtrees/?volume.name=fv&name=qt1"}},
"name": "qt1",
}
)
Retrieving qtrees
This API is used to retrieve qtrees.
The following example shows how to retrieve qtrees belonging to SVM svm1 and volume fv. The svm.name
and volume.name
query parameters are used to find the required qtrees.
from netapp_ontap import HostConnection
from netapp_ontap.resources import Qtree
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
print(list(Qtree.get_collection(**{"svm.name": "svm1", "volume.name": "fv"})))
[
Qtree(
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
},
},
"id": 0,
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
},
},
"_links": {
"self": {
"href": "/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/0"
}
},
"name": "",
}
),
Qtree(
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
},
},
"id": 1,
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
},
},
"_links": {
"self": {
"href": "/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/1"
}
},
"name": "qt1",
}
),
Qtree(
{
"svm": {
"uuid": "b68f961b-4cee-11e9-930a-005056a7f717",
"name": "svm1",
"_links": {
"self": {
"href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717"
}
},
},
"id": 2,
"volume": {
"uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
},
},
"_links": {
"self": {
"href": "/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/2"
}
},
"name": "qt2",
}
),
]
Retrieving properties of a specific qtree using a qtree identifier
This API is used to retrieve properties of a specific qtree using qtree.id.
The following example shows how to use the qtree identifier to retrieve all properties of the qtree using the fields
query parameter.
from netapp_ontap import HostConnection
from netapp_ontap.resources import Qtree
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = Qtree(id=2, **{"volume.uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717"})
resource.get(fields="*")
print(resource)
Retrieving properties of a specific qtree using the qtree name
This API is used to retrieve properties of a specific qtree using "qtree.name".
The following example shows how to retrieve all of the properties belonging to qtree "qt2". The svm.name
and volume.name
query parameters are used here along with the qtree name.
from netapp_ontap import HostConnection
from netapp_ontap.resources import Qtree
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
print(
list(
Qtree.get_collection(
name="qt2", fields="*", **{"svm.name": "svm1", "volume.name": "fv"}
)
)
)
Updating a qtree
This API is used to update a qtree.
The following example shows how to update properties in a qtree.
from netapp_ontap import HostConnection
from netapp_ontap.resources import Qtree
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = Qtree(id=2, **{"volume.uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717"})
resource.security_style = "mixed"
resource.user.name = "unix_user1"
resource.group.name = "unix_group1"
resource.unix_permissions = 777
resource.export_policy.id = "9"
resource.export_policy.name = "exp1"
resource.qos_policy.uuid = "39ac471f-ff35-11e9-b0f9-005056a7ab53"
resource.patch()
Renaming a qtree
This API is used to rename a qtree.
The following example below shows how to rename a qtree with a new name.
from netapp_ontap import HostConnection
from netapp_ontap.resources import Qtree
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = Qtree(id=1, **{"volume.uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717"})
resource.name = "new_qt1"
resource.patch()
Deleting a qtree inside a volume of an SVM
This API is used to delete a qtree inside a volume of an SVM.
The following example shows how to delete a qtree.
from netapp_ontap import HostConnection
from netapp_ontap.resources import Qtree
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = Qtree(id=2, **{"volume.uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717"})
resource.delete()
Classes
class Qtree (*args, **kwargs)
-
A qtree is a directory at the top level of a volume to which a custom export policy (for fine-grained access control) and a quota rule can be applied, if required.
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
-
Retrieves qtrees configured for all FlexVol volumes or FlexGroup volumes.
Use thefields
query parameter to retrieve all properties of the qtree. If thefields
query parameter is not used, then GET returns the qtreename
and qtreeid
only.Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the
fields
query parameter. SeeRequesting specific fields
to learn more. *statistics.*
Related ONTAP commands
qtree show
Learn more
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, body: typing.Union = None, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Deletes a qtree.
Related ONTAP commands
qtree 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.
body
- The body of the delete request. This could be a Resource instance or a dictionary object.
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 qtrees configured for all FlexVol volumes or FlexGroup volumes.
Use thefields
query parameter to retrieve all properties of the qtree. If thefields
query parameter is not used, then GET returns the qtreename
and qtreeid
only.Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the
fields
query parameter. SeeRequesting specific fields
to learn more. *statistics.*
Related ONTAP commands
qtree 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) -> typing.Iterable
-
Retrieves qtrees configured for all FlexVol volumes or FlexGroup volumes.
Use thefields
query parameter to retrieve all properties of the qtree. If thefields
query parameter is not used, then GET returns the qtreename
and qtreeid
only.Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the
fields
query parameter. SeeRequesting specific fields
to learn more. *statistics.*
Related ONTAP commands
qtree 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
objectsRaises
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 patch_collection(body: dict, *args, connection: HostConnection = None, **kwargs) -> NetAppResponse
-
Updates properties for a specific qtree.
Related ONTAP commands
qtree modify
qtree rename
Learn more
Patch all objects in a collection which match the given query.
All records on the host which match the query will be patched with the provided body.
Args
body
- A dictionary of name/value pairs to set on all matching members of the collection.
*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 patch 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. **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
NetAppResponse
object containing the details of the HTTP response.Raises
NetAppRestError
: If the API call returned a status code >= 400
Methods
def delete(self, body: typing.Union = None, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Deletes a qtree.
Related ONTAP commands
qtree 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 properties for a specific qtree identified by the
volume.uuid
and theid
in the API path.Expensive properties
There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the
fields
query parameter. SeeRequesting specific fields
to learn more. *statistics.*
Related ONTAP commands
qtree show
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 patch(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Updates properties for a specific qtree.
Related ONTAP commands
qtree modify
qtree rename
Learn more
Send the difference in the object's state to the host as a modification request.
Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.
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 def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse
-
Creates a qtree in a FlexVol volume or a FlexGroup volume.
After a qtree is created, the new qtree is assigned an identifier. This identifier is obtained using a qtree GET request. This identifier is used in the API path for the qtree PATCH and DELETE operations.Required properties
svm.uuid
orsvm.name
- Existing SVM in which to create the qtree.volume.uuid
orvolume.name
- Existing volume in which to create the qtree.name
- Name for the qtree.
Recommended optional properties
If not specified in POST, the values are inherited from the volume. *
security_style
- Security style for the qtree. *unix_permissions
- UNIX permissions for the qtree. *export_policy.name or export_policy.id
- Export policy of the SVM for the qtree.Related ONTAP commands
qtree create
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 QtreeSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)
-
The fields of the Qtree object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
export_policy GET POST PATCH
-
The export_policy field of the qtree.
-
group GET POST PATCH
-
The group field of the qtree.
-
id GET
-
The identifier for the qtree, unique within the qtree's volume.
Example: 1
-
links GET
-
The links field of the qtree.
-
name GET POST PATCH
-
The name of the qtree. Required in POST; optional in PATCH.
-
nas GET POST PATCH
-
The nas field of the qtree.
-
path GET
-
Client visible path to the qtree. This field is not available if the volume does not have a junction-path configured. Not valid in POST or PATCH. This field is to be deprecated and replaced with nas.path.
Example: /volume3/qtree1
-
qos_policy GET POST PATCH
-
The qos_policy field of the qtree.
-
security_style GET POST PATCH
-
The security_style field of the qtree.
-
statistics GET
-
The statistics field of the qtree.
-
svm GET POST
-
The svm field of the qtree.
-
unix_permissions GET POST PATCH
-
The UNIX permissions for the qtree. Valid in POST or PATCH.
Example: 493
-
user GET POST PATCH
-
The user field of the qtree.
-
volume GET POST
-
The volume field of the qtree.