JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle® ZFS Storage Appliance RESTful Application Programming Interface
Oracle Technology Network
Library
PDF
Print View
Feedback
search filter icon
search icon

Document Information

Using This Documentation

Chapter 1 Overview

Chapter 2 Working with the API

Chapter 3 Alert Service Commands

Chapter 4 Analytics Services

Chapter 5 Hardware Services

Chapter 6 Log Commands

Chapter 7 Network Commands

Chapter 8 Problem Service Commands

Chapter 9 Role Service

Chapter 10 SAN Services

Chapter 11 Service Commands

Chapter 12 Storage Services

Storage Pool Operations

List Pools

Get Pool

Configure Pool

Add Storage to a Pool

Pool Scrub

Unconfigure Pool

Project Operations

List Projects

Get Project Properties

Create Project

Modify Project

Delete Project

Project Usage

Filesystem Operations

List Filesystems

Get Filesystem

Create Filesystem

Modify Filesystem

Delete Filesystem

Filesystem Quota and Usage

LUN Operations

List LUNS

Get LUN

Create a New LUN

Modify LUN

Delete Lun

Snapshot and Clone Operations

List Snapshots

Get Snapshot

Create Snapshot

Rename Snapshot

Clone Snapshot

Rollback Snapshot

Delete a Snapshot

List Snapshot Dependents

Schema

List Properties

Get Property

Create Property

Modify Property

Delete Property

Replication

Get Replication Service

Modify Replication Service State

Replication Targets

List Replication Targets

Get Replication Target

Create Replication Target

Delete Replication Target

Replication Actions

List Replication Actions

Get Replication Action

Create Replication Action

Modify Replication Action

Cancel Update

Send Update

Delete a Replication Action

Replication Packages

List Replication Sources

List Replication Packages

Modify Package

Delete Package

Cancel Update

Clone Package

Sever Package

Reverse Package

Chapter 13 System Commands

Chapter 14 User Service

Chapter 15 Workflow Commands

Chapter 16 RESTful Clients

Filesystem Operations

Filesystem operations list and manage filesystem shares. All commands are scoped to a given storage pool or project.

{service_uri}/pools/{pool}/project/{project}
Table 12-10  Filesystem Commands
Request
Path /api/storage/v1
Description
GET
/filesystems
List all filesystems
GET
/pools/<pool>/projects /<project>/filesystems
List filesystems
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>
Get filesystem details
POST
/pools/<pool>/projects /<project>/filesystems
Create a filesystem
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>
Modify a filesystem
DELETE
/pools/<pool>/projects /<project>/filesystems /<filesystem>
Destroy a filesystem
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/groups
Get filesystem group usage
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/groups /<group>
Get filesystem usage for the specified group
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/groups
Create a filesystem group quota
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/groups /<name>
Modify a filesystem group quota
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/users
Get filesystem user usage
GET
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/users /<user>
Get filesystem usage for the specified user
POST
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/users
Create a filesystem user quota
PUT
/pools/<pool>/projects /<project>/filesystems /<filesystem>/usage/users /<name>
Modify a filesystem user quota

Each filesystem contains properties from the project and also have the following filesystem specific properties.

Table 12-11  Filesystem Properties
Type
Name
Description
string
casesensitivity
Case Sensitivity setting ("mixed", “sensitive” or “insensitive”)
string
group
The group name
string
normalization
Normalization
string
permissions
The filesystem permissions
string
project
The project name
boolean
quota_snap
Flag to include snapshots in the quota
boolean
reservation_snap
Flag to include snapshots in the reservation
string
shadow
Data migration source
string
sharesmb_name
Name of SMB share
object
source
Project inheritance properties
object
usage
File system usage information
string
user
The user name that owns the share
boolean
utf8only
Flag to reject non-UTF-8