Guía de la API de RESTful de Oracle^® ZFS Storage Appliance (versión OS8.8.x)

Destinos

Los comandos de destino iSCSI se usan para gestionar los destinos iSCSI y los grupos de destino iSCSI. Los comandos disponibles se detallan en la tabla de abajo.

Los comandos de destino toman los siguientes parámetros del URI.:

protocol

El protocolo SAN: fc, iscsi o srp

target

El ID del destino: IQN, WWN o EUI

Tabla 36  Comandos de destino

Solicitud Anexar a la ruta de acceso /san/v{1|2} Descripción GET /protocol/targets Detallar todos los destinos SAN para los objetos del protocolo determinados: fc, iscsi, srp GET /protocol/targets/target Obtener el destino SAN especificado para las propiedades del protocolo determinadas: fc, iscsi, srp POST /protocol/targets Crear un nuevo destino SAN para el protocolo determinado: fc, iscsi, srp PUT /protocol/targets/target Modificar el destino SAN especificado para el objeto del protocolo determinado: fc, iscsi, srp DELETE /protocol/targets/target Destruir el nombre de destino especificado.

Los comandos de obtención de destino devuelven propiedades del destino. Los comandos de creación y modificación de destino usan las propiedades que se muestran en la siguiente tabla como entrada.

Tabla 37  Propiedades de entrada de destino

Propiedad Protocolo Descripción alias iscsi Nombre simple en lenguaje natural iqn iscsi El nombre completo de iSCSI state iscsi Estado del destino iSCSI ("online", "offline") auth iscsi Tipo de autenticación opcional ("none", "chap") targetchapuser iscsi Autenticación de usuario CHAP opcional targetchapsecret iscsi Autenticación de usuario CHAP secret opcional interfaces iscsi Lista de interfaces de red en las que está disponible el destino wwn fc Nombre a nivel mundial para este objetivo port fc Ubicación física del puerto mode fc Modo de este puerto (iniciador o destino) speed fc Velocidad negociada de este puerto discovered_ports fc Número de puertos iniciadores remotos descubiertos alias srp Alias para la tarjeta SRP eui srp Identificador exclusivo extendido para este objetivo

Las siguientes propiedades se usan para obtener la información del grupo de destino iSCI.

Tabla 38  Propiedades del grupo de destino

Propiedad Tipo Descripción protocol string El protocolo del grupo de destino: FC, iSCSI o SRP name string El nombre del grupo de destino iSCSI targets array Una lista de miembros del grupo IQN de iSCSI de destino

Enumerar destinos

Muestra todos los destinos de SAN del protocolo especificado disponible en el dispositivo.

Ejemplo de solicitud:

GET /api/san/v1/iscsi/targets HTTP/1.1
Host: zfs-storage.example.com:215
Authorization: Basic Tm8gcGVla2luZyE=
Accept: application/json

Resultado de ejemplo:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1337

{
    "size": 7,
     "targets": [{
        "alias": "tst.volumes.py.12866.target",
        "href": "/api/san/v1/iscsi/targets/iqn.zfs-storage.example.com.sun:02:
            72b6fa9a-96c4-e511-db19-aadb9bac2052",
        "iqn": "iqn.zfs-storage.example.com.sun:02:72b6fa9a-96c4-
            e511-db19-aadb9bac2052",
        ...
    }, {
        "alias": "tst.volumes.py.96238.target",
         "href": "/api/san/v1/iscsi/targets/iqn.zfs-storage.example.com.sun:02:
            31d26d2e-6aa0-6054-fe58-8b1fb508b008",
        "iqn": "iqn.zfs-storage.example.com.sun:31d26d2e-6aa0-6054-fe58-8b1fb508b008",
        ...
    }
    ...]
}

Obtener detalles del destino

Obtiene propiedades de un solo destino. Para seleccionar el destino se puede usar la propiedad "iqn" o se puede usar "alias=alias".

Ejemplo de solicitud:

GET /api/san/v1/iscsi/targets/alias=test-target HTTP/1.1
Host: zfs-storage.example.com:215
Authorization: Basic Tm8gcGVla2luZyE=
Accept: application/json

Resultado de ejemplo:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 251

{
    "target": {
        "alias": "test-target",
        "auth": "none",
        "href": "/api/san/v1/iscsi/targets/alias=test-target",
        "interfaces": ["ixgbe0"],
        "iqn": "iqn.zfs-storage.example.com.sun:02:31d26d2e-6aa0-6054-fe58-8b1fb508b008",
        "targetchapsecret": "",
        "targetchapuser": ""
    }
}

Crear un destino

Crear un nuevo destino. La solicitud tiene un objeto JSON con una sola propiedad name que es el nombre del nuevo grupo de destino iSCSI.

Ejemplo de solicitud:

POST /api/san/v1/iscsi/targets HTTP/1.1
Host: zfs-storage.example.com:215
Authorization: Basic Tm8gcGVla2luZyE=
Content-Type: application/json
Content-Length: 23
Accept: application/json

{"alias": "test-target"}

Resultado de ejemplo:

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 233
X-Zfssa-San-Api: 1.0
Location: /api/san/v1/iscsi/targets/iqn.zfs-storage.example.com.sun:02:31d26d2e-6aa0-6054-fe58-8b1fb508b008

{
    "target": {
        "href": "/api/san/v1/iscsi/targets/iqn.zfs-storage.example.com.sun:02:31d26d2e-6aa0-6054-fe58-8b1fb508b008",
        "alias": "test-target",
        "iqn": "iqn.zfs-storage.example.com.sun:02:31d26d2e-6aa0-6054-fe58-8b1fb508b008",
        "auth": "none",
        "targetchapuser": "",
        "targetchapsecret": "",
        "interfaces": ["ixgbe0"]
    }
}

Modificar un destino

Modifica un destino iSCSI existente. El cuerpo de solicitud contiene un objeto JSON que contiene las propiedades de destino iSCSI que se modifican. Cuando esto es correcto, se devuelve HTTP Status 202 (Accepted) (estado HTTP 202 [aceptado]). El cuerpo de la respuesta contiene las propiedades de destino iSCSI para el destino codificado en un objeto JSON.

Ejemplo de solicitud:

PUT /api/san/v1/iscsi/targets/alias=test-target HTTP/1.1
Host: zfs-storage.example.com:215
Authorization: Basic Tm8gcGVla2luZyE=
Content-Type: application/json
Content-Length: 54
Accept: application/json

{"targetchapsecret":"secret", "auth":"chap",
 "targetchapuser":"admin5"}

Resultado de ejemplo:

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 189
X-Zfssa-San-Api: 1.0

{
    "target": {
        "href": "/api/san/v1/iscsi/targets/alias=test-target",
        "auth": "chap",
        "targetchapsecret": "secret",
        "alias": "test-target",
        "iqn": "iqn.zfs-storage.example.com.sun:02:31d26d2e-6aa0-6054-fe58-8b1fb508b008",
        "targetchapuser": "admin5",
        "interfaces": ["ixgbe0"]
    }
}

Suprimir un destino

Suprime un destino SAN del sistema.

Ejemplo de solicitud:

DELETE /api/san/v1/iscsi/targets/iqn.zfs-storage.example.com.sun:02:e7e688b1 HTTP/1.1
Host: zfs-storage.example.com:215
Authorization: Basic Tm8gcGVla2luZyE=

La supresión satisfactoria devuelve HTTP code 204 (No Content) (código HTTP 204 [sin contenido]):

HTTP/1.1 204 No-Content