Skip to main content
A newer release of this product is available.

Update properties for a qtree

Contributors
PDFs

PATCH /storage/qtrees/{volume.uuid}/{id}

Updates properties for a specific qtree.

  • qtree modify

  • qtree rename

Learn more

Parameters

Name Type In Required Description

volume.uuid

string

path

True

Volume UUID

id

string

path

True

Qtree ID

Request Body

Name Type Description

_links

_links

export_policy

export_policy

Export Policy

id

integer

The identifier for the qtree, unique within the qtree's volume.

name

string

The name of the qtree. Required in POST; optional in PATCH.

path

string

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.

security_style

string

Security style. Valid in POST or PATCH.

svm

svm

Required in POST

unix_permissions

integer

The UNIX permissions for the qtree. Valid in POST or PATCH.

volume

volume

Required in POST
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "export_policy": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "id": 100,
    "name": "default"
  },
  "id": 1,
  "name": "string",
  "path": "/volume3/qtree1",
  "security_style": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "unix_permissions": 493,
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

918235

A volume with UUID was not found.

5242951

Export policy supplied does not belong to the specified export policy ID.

5242955

The UUID of the volume is required.

5242956

Failed to obtain qtree with ID.

5242958

Failed to rename qtree in volume in SVM with ID.

5242959

Successfully renamed qtree but modify failed.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

export_policy

Export Policy

Name Type Description

_links

_links

id

integer

name

string

svm

Required in POST

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

volume

Required in POST

Name Type Description

_links

_links

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

qtree

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.

Name Type Description

_links

_links

export_policy

export_policy

Export Policy

id

integer

The identifier for the qtree, unique within the qtree's volume.

name

string

The name of the qtree. Required in POST; optional in PATCH.

path

string

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.

security_style

string

Security style. Valid in POST or PATCH.

svm

svm

Required in POST

unix_permissions

integer

The UNIX permissions for the qtree. Valid in POST or PATCH.

volume

volume

Required in POST
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.