mirror_iproute2/man/man8/vdpa.8
Parav Pandit c2ecc82b9d vdpa: Add vdpa tool
vdpa tool is created to create, delete and query vdpa devices.
examples:
Show vdpa management device that supports creating, deleting vdpa devices.

$ vdpa mgmtdev show
vdpasim:
  supported_classes net

$ vdpa mgmtdev show -jp
{
    "show": {
        "vdpasim": {
            "supported_classes": [ "net" ]
        }
    }
}

Create a vdpa device of type networking named as "foo2" from
the management device vdpasim_net:

$ vdpa dev add mgmtdev vdpasim_net name foo2

Show the newly created vdpa device by its name:
$ vdpa dev show foo2
foo2: type network mgmtdev vdpasim_net vendor_id 0 max_vqs 2 max_vq_size 256

$ vdpa dev show foo2 -jp
{
    "dev": {
        "foo2": {
            "type": "network",
            "mgmtdev": "vdpasim_net",
            "vendor_id": 0,
            "max_vqs": 2,
            "max_vq_size": 256
        }
    }
}

Delete the vdpa device after its use:
$ vdpa dev del foo2

Signed-off-by: Parav Pandit <parav@nvidia.com>
Signed-off-by: David Ahern <dsahern@kernel.org>
2021-02-11 09:09:15 -07:00

77 lines
1.4 KiB
Groff

.TH VDPA 8 "5 Jan 2021" "iproute2" "Linux"
.SH NAME
vdpa \- vdpa management tool
.SH SYNOPSIS
.sp
.ad l
.in +8
.ti -8
.B vdpa
.RI "[ " OPTIONS " ] { " dev | mgmtdev " } { " COMMAND " | "
.BR help " }"
.sp
.SH OPTIONS
.TP
.BR "\-V" , " --Version"
Print the version of the
.B vdpa
utility and exit.
.TP
.BR "\-j" , " --json"
Generate JSON output.
.TP
.BR "\-p" , " --pretty"
When combined with -j generate a pretty JSON output.
.SS
.I OBJECT
.TP
.B dev
- vdpa device.
.TP
.B mgmtdev
- vdpa management device.
.SS
.I COMMAND
Specifies the action to perform on the object.
The set of possible actions depends on the object type.
It is possible to
.B show
(or
.B list
) objects. The
.B help
command is available for all objects. It prints
out a list of available commands and argument syntax conventions.
.sp
If no command is given, some default command is assumed.
Usually it is
.B show
or, if the objects of this class cannot be listed,
.BR "help" .
.SH EXIT STATUS
Exit status is 0 if command was successful or a positive integer upon failure.
.SH SEE ALSO
.BR vdpa-dev (8),
.BR vdpa-mgmtdev (8),
.br
.SH REPORTING BUGS
Report any bugs to the Network Developers mailing list
.B <netdev@vger.kernel.org>
where the development and maintenance is primarily done.
You do not have to be subscribed to the list to send a message there.
.SH AUTHOR
Parav Pandit <parav@nvidia.com>