diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 4e6577623..951fe5e59 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -996,7 +996,7 @@ Array of names of newly created bdevs. Name | Optional | Type | Description ----------------------- | -------- | ----------- | ----------- -name | Required | string | Bdev name +name | Required | string | Name of the NVMe controller, prefix for each bdev name trtype | Required | string | NVMe-oF target trtype: rdma or pcie traddr | Required | string | NVMe-oF target address: ip or BDF adrfam | Optional | string | NVMe-oF target adrfam: ipv4, ipv6, ib, fc, intra_host diff --git a/scripts/rpc.py b/scripts/rpc.py index eb8f41448..6fc7a7eda 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -278,8 +278,8 @@ if __name__ == "__main__": subnqn=args.subnqn)) p = subparsers.add_parser('construct_nvme_bdev', - help='Add bdev with nvme backend') - p.add_argument('-b', '--name', help="Name of the bdev", required=True) + help='Add bdevs with nvme backend') + p.add_argument('-b', '--name', help="Name of the NVMe controller, prefix for each bdev name", required=True) p.add_argument('-t', '--trtype', help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) p.add_argument('-a', '--traddr', diff --git a/scripts/rpc/bdev.py b/scripts/rpc/bdev.py index 6c7d0ecd3..b65b2d9ea 100644 --- a/scripts/rpc/bdev.py +++ b/scripts/rpc/bdev.py @@ -216,7 +216,7 @@ def set_bdev_nvme_hotplug(client, enable, period_us=None): def construct_nvme_bdev(client, name, trtype, traddr, adrfam=None, trsvcid=None, subnqn=None): - """Construct NVMe namespace block device. + """Construct NVMe namespace block devices. Args: name: bdev name prefix; "n" + namespace ID will be appended to create unique names @@ -227,7 +227,7 @@ def construct_nvme_bdev(client, name, trtype, traddr, adrfam=None, trsvcid=None, subnqn: subsystem NQN to connect to (optional) Returns: - Name of created block device. + Names of created block devices. """ params = {'name': name, 'trtype': trtype,