Module netapp_ontap.resources.qtree
Copyright © 2019 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 or a FlexGroup volume.
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 with a given security style, UNIX permissions, and an export policy.
# The API:
POST /api/storage/qtrees
# The call:
curl -X POST 'https://<mgmt-ip>/api/storage/qtrees?return_records=true' -H 'accept: application/hal+json' -d @test_qtree_post.txt
test_qtree_post.txt(body):
{
"svm": {
"name": "svm1"
},
"volume": {
"name": "fv"
},
"name": "qt1",
"security_style": "unix",
"unix_permissions": 744,
"export_policy": {
"name": "default"
}
}
# The response:
{
"num_records": 1,
"records": [
{
"svm": {
"name": "svm1"
},
"volume": {
"name": "fv"
},
"name": "qt1",
"security_style": "unix",
"unix_permissions": 744,
"export_policy": {
"name": "default"
},
"_links": {
"self": {
"href": "/api/storage/qtrees/?volume.name=fv&name=qt1"
}
}
}
],
"job": {
"uuid": "84edef3c-4f6d-11e9-9a71-005056a7f717",
"_links": {
"self": {
"href": "/api/cluster/jobs/84edef3c-4f6d-11e9-9a71-005056a7f717"
}
}
}
}
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.
# The API:
GET /api/storage/qtrees
# The call:
curl -X GET "https://<mgmt-ip>/api/storage/qtrees/?svm.name=svm1&volume.name=fv" -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": "cb20da45-4f6b-11e9-9a71-005056a7f717",
"name": "fv",
"_links": {
"self": {
"href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717"
}
}
},
"id": 0,
"name": "",
"_links": {
"self": {
"href": "/api/storage/qtrees/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"
}
}
},
"id": 1,
"name": "qt1",
"_links": {
"self": {
"href": "/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/1"
}
}
},
{
"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"
}
}
},
"id": 2,
"name": "qt2",
"_links": {
"self": {
"href": "/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/2"
}
}
}
],
"num_records": 3,
"_links": {
"self": {
"href": "/api/storage/qtrees/?svm.name=svm1&volume.name=fv"
}
}
}
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.
# The API:
GET /api/storage/qtrees/{volume.uuid}/{id}
# The call:
curl -X GET 'https://<mgmt-ip>/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/2?fields=*' -H 'accept: application/hal+json'
{
"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"
}
}
},
"id": 2,
"name": "qt2",
"security_style": "unix",
"unix_permissions": 744,
"export_policy": {
"name": "default",
"id": 12884901889,
"_links": {
"self": {
"href": "/api/protocols/nfs/export-policies/12884901889"
}
}
},
"path": "/fv/qt2",
"_links": {
"self": {
"href": "/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/2"
}
}
}
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.
# The API:
GET /api/storage/qtrees/
# The call:
curl -X GET 'https://<mgmt-ip>/api/storage/qtrees/?svm.name=svm1&volume.name=fv&name=qt2&fields=*' -H 'accept: application/hal+json'
{
"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"
}
}
},
"id": 2,
"name": "qt2",
"security_style": "unix",
"unix_permissions": 744,
"export_policy": {
"name": "default",
"id": 12884901889,
"_links": {
"self": {
"href": "/api/protocols/nfs/export-policies/12884901889"
}
}
},
"_links": {
"self": {
"href": "/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/2"
}
}
}
Updating a qtree
This API is used to update a qtree.
The following example shows how to update properties in a qtree.
# The API:
PATCH /api/storage/qtrees/{volume.uuid}/{id}
# The call:
curl -X PATCH 'https://<mgmt-ip>/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/2' -H 'accept: application/hal+json' -d '@test_qtree_patch.txt'
test_qtree_patch.txt(body):
{
"security_style": "mixed",
"unix_permissions": 777,
"export_policy": {
"id": "9",
"name": "exp1"
}
}
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.
# The API:
PATCH /api/storage/qtrees/{volume.uuid}/{id}
# The call:
curl -X PATCH 'https://<mgmt-ip>/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/1' -H 'accept: application/hal+json' -d '{ "name": "new_qt1" }'
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.
# The API:
DELETE /api/storage/qtrees/{volume.uuid}/{id}
# The call:
curl -X DELETE "https://<mgmt-ip>/api/storage/qtrees/cb20da45-4f6b-11e9-9a71-005056a7f717/2" -H 'accept: application/hal+json'
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 delete_collection(*args, 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.
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 def find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Retrieves qtrees configured for all FlexVols 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.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 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 qtrees configured for all FlexVols 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.Related ONTAP commands
qtree show
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. 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, 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
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.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 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 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 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 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
Inherited members
class QtreeSchema (only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)
-
The fields of the Qtree object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.schema.BaseSchema
- marshmallow.base.SchemaABC
Class variables
var export_policy
-
The export_policy field of the qtree.
var id
-
The identifier for the qtree, unique within the qtree's volume.
Example: 1
var links
-
The links field of the qtree.
var name
-
The name of the qtree. Required in POST; optional in PATCH.
var opts
var path
-
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.
Example: /volume3/qtree1
var security_style
-
The security_style field of the qtree.
var svm
-
The svm field of the qtree.
var unix_permissions
-
The UNIX permissions for the qtree. Valid in POST or PATCH.
Example: 493
var volume
-
The volume field of the qtree.