From 1da395bc1014061209440bd095f887bbd6471f3a Mon Sep 17 00:00:00 2001 From: Ben Walker Date: Tue, 8 Sep 2020 13:52:01 -0700 Subject: [PATCH] rpc: Document iscsi_initiator_group_remove_initiators Signed-off-by: Ben Walker Change-Id: I5c8adc433640b0f44222db73421896dfc01bb298 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4108 Tested-by: SPDK CI Jenkins Reviewed-by: Paul Luse Reviewed-by: Shuhei Matsumoto Reviewed-by: Tomasz Zawadzki Reviewed-by: Jim Harris --- doc/jsonrpc.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index c5ce5783b..f921adf5b 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -3731,6 +3731,51 @@ response: } ~~~ +## iscsi_initiator_group_remove_initiators method {#rpc_iscsi_initiator_group_remove_initiators} + +Remove initiators from an initiator group. + +### Parameters + +Name | Optional | Type | Description +--------------------------- | -------- | --------| ----------- +tag | Required | number | Existing initiator group tag. +initiators | Optional | array | Array of initiator hostnames or IP addresses +netmasks | Optional | array | Array of initiator netmasks + +### Example + +Example request: + +~~~ +request: +{ + "params": { + "initiators": [ + "iqn.2016-06.io.spdk:host3" + ], + "tag": 1, + "netmasks": [ + "255.255.255.1" + ] + }, + "jsonrpc": "2.0", + "method": "iscsi_initiator_group_remove_initiators", + "id": 1 +} +~~~ + +Example response: + +~~~ +response: +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + ## iscsi_get_target_nodes method {#rpc_iscsi_get_target_nodes} Show information about all available iSCSI target nodes.