Guide RESTful API des systèmes Oracle^® ZFS Storage Appliance, version OS8.8.x

Cibles

Les commandes de cibles iSCSI sont utilisées pour gérer les cibles iSCSI et les groupes de cibles iSCSI. Les commandes disponibles sont répertoriées dans le tableau ci-dessous.

Les commandes cibles utilisent les paramètres URI suivants :

protocol

Protocole SAN : fc, iscsi ou srp

target

ID de la cible : IQN, WWN ou EUI

Table 36  Commandes cible

Demande Ajouter au chemin /san/v{1|2} Description GET /protocol/targets Enumération de toutes les cibles SAN pour les objets du protocole donné : fc, iscsi, srp GET /protocol/targets/target Obtention de la cible SAN spécifiée pour les propriétés du protocole donné : fc, iscsi, srp POST /protocol/targets Création d'une nouvelle cible SAN pour le protocole donné : fc, iscsi, srp PUT /protocol/targets/target Modification de la cible SAN spécifiée pour l'objet du protocole donné : fc, iscsi, srp DELETE /protocol/targets/target Destruction de l'objet cible spécifié

Les commandes get target renvoient les propriétés de la cible. Les commandes create et modify target utilisent les propriétés répertoriées dans le tableau suivant en tant que valeurs d'entrée.

Table 37  Propriétés d'entrée cible

Propriété Protocole Description alias iscsi Nom simple lisible par les êtres humains iqn iscsi Nom qualifié iSCSI state iscsi Etat de la cible iSCSI ("online", "offline") auth iscsi Type d'authentification facultative ("none", "chap") targetchapuser iscsi Authentification de l'utilisateur CHAP facultative targetchapsecret iscsi Secret d'authentification CHAP facultatif interfaces iscsi Liste des interfaces réseau disponibles pour cette cible wwn fc Nom Worldwide pour cette cible port fc Emplacement physique du port mode fc Mode de ce port (initiateur ou cible) speed fc Vitesse négociée de ce port discovered_ports fc Nombre de ports initiateur distants découverts alias srp Alias de la cible SRP eui srp Identificateur unique étendu (EUI, Extended Unique Identifier) de cette cible

Les propriétés suivantes sont utilisées pour obtenir les informations du groupe de cibles iSCSI.

Table 38  Propriétés du groupe de cibles

Propriété Type Description protocol string Protocole du groupe de cibles : FC, iSCSI ou SRP name string Nom du groupe de cibles iSCSI targets tableau Liste des membres du groupe IQN des cibles iSCSI

Liste des cibles

Répertorie toutes les cibles SAN du protocole spécifié disponibles sur l'appareil.

Exemple de demande :

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

Exemple de résultat :

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",
        ...
    }
    ...]
}

Obtention des détails d'une cible

Obtient les propriétés à partir d'une cible unique. La cible peut être sélectionnée à l'aide de la propriété "iqn" ou en utilisant "alias=alias".

Exemple de demande :

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

Exemple de résultat :

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": ""
    }
}

Création d'une cible

Crée une nouvelle cible. Le corps de la demande contient un objet JSON avec une seule propriété name, qui est le nom du nouveau groupe cible iSCSI.

Exemple de demande :

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"}

Exemple de résultat :

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"]
    }
}

Modification d'une cible

Modifie une cible iSCSI existante. Le corps de la demande contient un objet JSON contenant les propriétés de la cible iSCSI en cours de modification. Le code de statut HTTP 202 (Accepted) est renvoyé en cas de succès. Le corps de la réponse contient les propriétés de la cible iSCSI résultante pour la cible encodée dans un objet JSON.

Exemple de demande :

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"}

Exemple de résultat :

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"]
    }
}

Suppression d'une cible

Supprime une cible SAN du système.

Exemple de demande :

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=

Une suppression réussie renvoie le code HTTP 204 (No Content) :

HTTP/1.1 204 No-Content