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

LUN Operations

All LUN or volume operations are scoped to a given pool or project. The following LUN commands are available.

Table 12-17  Volume Commands
Request
Path /api/storage/v1
Description
GET
/luns
List all LUNS
GET
/pools/<pool>/projects /<project>/luns
List LUNS
GET
/pools/<pool>/projects /<project>/luns/<lun>
Get LUN details
POST
/pools/<pool>/projects /<project>/luns
Create a LUN
PUT
/pools/<pool>/projects /<project>/luns/<lun>
Modify a LUN
DELETE
/pools/<pool>/projects /<project>/luns/<lun>
Destroy a LUN

The following table lists the LUN properties. Volumes can also inherit or override project properties.

Table 12-18  Volume Properties
Type
Name
Description
string
assignednumber
The assigned LU number.
boolean
fixednumber
Flag to fix LU number at current value
string
initiatorgroup
The initiator group
string
lunguid
STMF GUID
string
lunnumber
The LU number. Either a number or “auto”
string
project
The project name (immutable)
object
source
Lists source of properties ("local", "inherited")
boolean
sparse
Flag to enable thin provisioning
string
status
Logical unit status ("online", "offline")
string
targetgroup
The target group
object
usage
Lists LUN usage statistics
number
volblocksize
Volume block size
number
volsize
Volume size
boolean
writecache
Flag to enable write cache

Some properties can be inherited from the project. The source object lists each of these properties and identifies whether the property is "local" to the LUN or is "inherited" from the project. By default these properties are inherited by the project. Once set then they are local to the LUN. The source object is immutable. To change the source back to inherited, the properties can be "unset".

Example JSON Request to Unset Compression:

{"unset": ["compression"]}