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

Overview

Initiators

List Initiators

Get Initiator Details

Create an Initiator

Modify an Initiator

Delete an Initiator

Initiator Groups

List Initiator Groups

Get Initiator Group Details

Create an Initiator Group

Delete an Initiator Group

Targets

List Targets

Get Target Details

Create a Target

Modify a Target

Delete a Target

Target Groups

List Target Groups

Get Target Group

Create a Target Group

Delete a Target Group

Chapter 11 Service Commands

Chapter 12 Storage Services

Chapter 13 System Commands

Chapter 14 User Service

Chapter 15 Workflow Commands

Chapter 16 RESTful Clients

Targets

The iSCSI target commands are used to manage iSCSI targets and iSCSI target groups. The available commands are listed below.

Table 10-7  Target Commands
Request
Path /san/v1.0
Description
GET
/<protocol>/targets
List all SAN target for the given protocol (FC, iSCSI, SRP) objects
GET
/<protocol>/targets/<target>
Get the specified SAN target for the given protocol (FC, iSCSI, SRP) properties
POST
/<protocol>/targets
Create a new SAN target for the given protocol (FC, iSCSI, SRP)
PUT
/<protocol>/targets/<target>
Modify the specified SAN target for the given protocol (FC, iSCSI, SRP) object
DELETE
/<protocol>/targets/<target>
Destroy the specified target object

The commands take the following URI parameters

Table 10-8  URI Paramters
Type
Name
Description
string
protocol
The SAN protocol (FC, iSCSI, SRP)
string
target
The target ID (IQN, WWN, EUI)

All the "get" target commands return target properties, and the "create" and modify "target" commands use the following properties as input.

Table 10-9  Target Properties
Name
Protocol
Description
alias
iscsi
Simple human readable name
iqn
iscsi
The iSCSI qualifed name
state
iscsi
State of the iSCSI target ("online", "offline")
auth
iscsi
Optional authentication type ("none", "chap")
targetchapuser
iscsi
Optional CHAP user authentication
targetchapsecret
iscsi
Optional CHAP secret authentication
interfaces
iscsi
List of network interfaces that target is available
wwn
fc
Worldwide name for this target
port
fc
Physical location of the port
mode
fc
Mode of this port (initiator or target)
speed
fc
Negotiated speed of this port
discovered_ports
fc
Number of discovered remote initiator ports
alias
srp
Alias for the SRP target
eui
srp
Extended unique identifier for this target

The following properties are used for getting iSCSI target group information.

Table 10-10  Target Group Properties
Type
Name
Description
string
protocol
The target group protocol (FC, iSCSI, SRP)
string
name
The iSCSI target group name
array
targets
A list of iSCSI target IQN group members