Commit 50e616c5 authored by Jacek Kalwas's avatar Jacek Kalwas Committed by Jim Harris
Browse files

doc: unify nvmf_create_subsystem description 



An inconsistency was spotted due to an unexpected limit on namespaces.
The `max_namespaces` contract was confirmed in the rpc.py client but was
not aligned with the implementation and documentation in jsonrpc.md.

Additional inconsistencies were identified and fixed.

Change-Id: I9ca1dc3a8bb7565a7c7021e05385a233e801a69c
Signed-off-by: default avatarJacek Kalwas <jacek.kalwas@intel.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/25622


Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz@tzawadzki.com>
Reviewed-by: default avatarJim Harris <jim.harris@nvidia.com>
parent 6adcfcf0

doc/jsonrpc.md

+6 −6
Original line number Diff line number Diff line
@@ -8419,18 +8419,18 @@ Construct an NVMe over Fabrics target subsystem. 


Name                       | Optional | Type        | Description

-------------------------- | -------- | ----------- | -----------

nqn                        | Required | string      | Subsystem NQN

nqn                        | Required | string      | Subsystem NQN.

tgt_name                   | Optional | string      | Parent NVMe-oF target name.

serial_number              | Optional | string      | Serial number of virtual controller

model_number               | Optional | string      | Model number of virtual controller

serial_number              | Optional | string      | Serial number of virtual controller.

model_number               | Optional | string      | Model number of virtual controller.

max_namespaces             | Optional | number      | Maximum number of namespaces that can be attached to the subsystem. Default: 32 (also used if user specifies 0)

allow_any_host             | Optional | boolean     | Allow any host (`true`) or enforce allowed host list (`false`). Default: `false`.

ana_reporting              | Optional | boolean     | Enable ANA reporting feature (default: `false`).

allow_any_host             | Optional | boolean     | Allow any host (`true`) or enforce allowed host list (`false`). Default: `false`

ana_reporting              | Optional | boolean     | Enable ANA reporting feature. Default: `false`

min_cntlid                 | Optional | number      | Minimum controller ID. Default: 1

max_cntlid                 | Optional | number      | Maximum controller ID. Default: 0xffef

max_discard_size_kib       | Optional | number      | Maximum discard size (Kib). Default: 0

max_write_zeroes_size_kib  | Optional | number      | Maximum write_zeroes size (Kib). Default: 0

passthrough                | Optional | boolean     | Use NVMe passthrough for I/O commands and namespace-directed admin commands. Default: `false`.

passthrough                | Optional | boolean     | Use NVMe passthrough for I/O commands and namespace-directed admin commands. Default: `false`



#### Example

python/spdk/rpc/nvmf.py

+9 −9
Original line number Diff line number Diff line
@@ -202,17 +202,17 @@ def nvmf_create_subsystem(client, 


    Args:

        nqn: Subsystem NQN.

        tgt_name: name of the parent NVMe-oF target (optional).

        serial_number: Serial number of virtual controller.

        model_number: Model number of virtual controller.

        allow_any_host: Allow any host (True) or enforce allowed host list (False). Default: False.

        max_namespaces: Maximum number of namespaces that can be attached to the subsystem (optional). Default: 0 (Unlimited).

        ana_reporting: Enable ANA reporting feature. Default: False.

        tgt_name: Parent NVMe-oF target name. (Optional)

        serial_number: Serial number of virtual controller. (Optional)

        model_number: Model number of virtual controller. (Optional)

        max_namespaces: Maximum number of namespaces that can be attached to the subsystem. Default: 32 (also used if user specifies 0)

        allow_any_host: Allow any host (`true`) or enforce allowed host list (`false`). Default: `false`

        ana_reporting: Enable ANA reporting feature. Default: `false`

        min_cntlid: Minimum controller ID. Default: 1

        max_cntlid: Maximum controller ID. Default: 0xffef

        max_discard_size: Maximum discard size (Kib). Default: 0

        max_write_zeroes_size: Maximum write_zeroes size (Kib). Default: 0

        passthrough: for all I/O commands and namespace-directed admin commands. Default: False.

        max_discard_size_kib: Maximum discard size (Kib). Default: 0

        max_write_zeroes_size_kib: Maximum write_zeroes size (Kib). Default: 0

        passthrough: Use NVMe passthrough for I/O commands and namespace-directed admin commands. Default: `false`





    Returns: