ctladm.8: fix several errors in the "port" section

* Document the "-d" option.
* Add the "-c" and "-r" options to the summary.
* Correct the list of required options.
* Clarify that the "-t" option is only for use with "-o", "-w", and "-W"
* Replace references to the nonexistent "-n" with "-p".

Also, fix a few related error strings in the ctladm command.

MFC after:	2 weeks
Sponsored by:	Axcient
Reviewed by:	jhb
Differential Revision: https://reviews.freebsd.org/D45503
This commit is contained in:
Alan Somers
2024-06-05 14:13:04 -06:00
parent 7dd39ef4e0
commit 60107d23d8
2 changed files with 32 additions and 7 deletions
+28 -4
View File
@@ -35,7 +35,7 @@
.\"
.\" $Id: //depot/users/kenm/FreeBSD-test2/usr.sbin/ctladm/ctladm.8#3 $
.\"
.Dd May 2, 2024
.Dd June 5, 2024
.Dt CTLADM 8
.Os
.Sh NAME
@@ -162,6 +162,7 @@
.Nm
.Ic port
.Op Fl c
.Op Fl d Ar driver
.Op Fl o Ar on|off
.Op Fl w Ar wwpn
.Op Fl W Ar wwnn
@@ -598,6 +599,10 @@ The serial number is returned when the error is injected.
Perform one of several CTL frontend port operations.
Either get a list of frontend ports
.Pq Fl l ,
create a new frontend port
.Pq Fl c ,
destroy a frontend port
.Pq Fl r ,
turn one or more frontends on
or off
.Pq Fl o Ar on|off ,
@@ -607,6 +612,8 @@ or World Wide Port Name
.Pq Fl W Ar wwpn
for a given port.
One of
.Fl c ,
.Fl r ,
.Fl l ,
.Fl o ,
or
@@ -619,6 +626,18 @@ combined with enabling/disabling or listing ports.
.Bl -tag -width 12n
.It Fl c
Create new frontend port using free pp and vp=0.
.It Fl d Ar driver
Specify the name of the frontend driver used by the
.Pq Fl c
or
.Pq Fl r
subcommands.
Valid driver names include
.Dq ioctl ,
.Dq iscsi ,
and
.Dq nvmf ,
but more can be added by external kernel modules.
.It Fl o Ar on|off
Turn the specified CTL frontend ports on or off.
If no port number or port type is specified, all ports are turned on or
@@ -633,7 +652,12 @@ The port numbers can be found in the frontend port list.
Remove port specified with
.Pq Fl p Ar targ_port .
.It Fl t Ar fe_type
Specify the frontend type.
Specify the frontend type used by the
.Pq Fl o ,
.Pq Fl w ,
and
.Pq Fl W
subcommands.
Currently defined port types are
.Dq fc
(Fibre Channel),
@@ -647,7 +671,7 @@ and
.It Fl w Ar wwnn
Set the World Wide Node Name for the given port.
The
.Fl n
.Fl p
argument must be specified, since this is only possible to implement on a
single port.
As a general rule, the WWNN should be the same across all ports on the
@@ -655,7 +679,7 @@ system.
.It Fl W Ar wwpn
Set the World Wide Port Name for the given port.
The
.Fl n
.Fl p
argument must be specified, since this is only possible to implement on a
single port.
As a general rule, the WWPN must be different for every port in the system.
+4 -3
View File
@@ -546,7 +546,7 @@ cctl_port(int fd, int argc, char **argv, char *combinedopt)
* we'll throw an error, since that only works on one port at a time.
*/
if ((port_type != CTL_PORT_NONE) && (targ_port != -1)) {
warnx("%s: can only specify one of -t or -n", __func__);
warnx("%s: can only specify one of -t or -p", __func__);
retval = 1;
goto bailout;
} else if ((targ_port == -1) && (port_type == CTL_PORT_NONE))
@@ -630,7 +630,7 @@ cctl_port(int fd, int argc, char **argv, char *combinedopt)
}
case CCTL_PORT_MODE_SET:
if (targ_port == -1) {
warnx("%s: -w and -W require -n", __func__);
warnx("%s: -w and -W require -p", __func__);
retval = 1;
goto bailout;
}
@@ -679,7 +679,8 @@ cctl_port(int fd, int argc, char **argv, char *combinedopt)
return (retval);
bailout_badarg:
warnx("%s: only one of -l, -o or -w/-W may be specified", __func__);
warnx("%s: only one of -c, -r, -l, -o or -w/-W may be specified",
__func__);
return (1);
}