Add documentation for "ctld -u", the UCL configuration file format.
Submitted by: jceel@ Reviewed by: wblock@ MFC after: 3 days Differential Revision: https://reviews.freebsd.org/D7222
This commit is contained in:
parent
82b8a87964
commit
2b30a69dc0
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=303132
@ -28,7 +28,7 @@
|
|||||||
.\"
|
.\"
|
||||||
.\" $FreeBSD$
|
.\" $FreeBSD$
|
||||||
.\"
|
.\"
|
||||||
.Dd November 9, 2015
|
.Dd July 21, 2016
|
||||||
.Dt CTL.CONF 5
|
.Dt CTL.CONF 5
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@ -481,6 +481,97 @@ target naa.50015178f369f092 {
|
|||||||
lun 0 example_1
|
lun 0 example_1
|
||||||
}
|
}
|
||||||
.Ed
|
.Ed
|
||||||
|
.Pp
|
||||||
|
An equivalent configuration in UCL format, for use with
|
||||||
|
.Fl u :
|
||||||
|
.Bd -literal
|
||||||
|
auth-group {
|
||||||
|
ag0 {
|
||||||
|
chap-mutual = [
|
||||||
|
{
|
||||||
|
user = "user"
|
||||||
|
secret = "secretsecret"
|
||||||
|
mutual-user = "mutualuser"
|
||||||
|
mutual-secret = "mutualsecret"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
user = "user2"
|
||||||
|
secret = "secret2secret2"
|
||||||
|
mutual-user = "mutualuser"
|
||||||
|
mutual-secret = "mutualsecret"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
ag1 {
|
||||||
|
auth-type = none
|
||||||
|
initiator-name = [
|
||||||
|
"iqn.2012-06.com.example:initiatorhost1",
|
||||||
|
"iqn.2012-06.com.example:initiatorhost2"
|
||||||
|
]
|
||||||
|
initiator-portal = [192.168.1.1/24, "[2001:db8::de:ef]"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
portal-group {
|
||||||
|
pg0 {
|
||||||
|
discovery-auth-group = no-authentication
|
||||||
|
listen = [
|
||||||
|
0.0.0.0:3260,
|
||||||
|
"[::]:3260",
|
||||||
|
"[fe80::be:ef]:3261"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
lun {
|
||||||
|
example_0 {
|
||||||
|
path = /dev/zvol/tank/example_0
|
||||||
|
blocksize = 4096
|
||||||
|
size = "4G"
|
||||||
|
}
|
||||||
|
|
||||||
|
example_1 {
|
||||||
|
path = /dev/zvol/tank/example_1
|
||||||
|
options {
|
||||||
|
naa = "0x50015178f369f093"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
example_2 {
|
||||||
|
path = /dev/zvol/tank/example_2
|
||||||
|
options {
|
||||||
|
vendor = "FreeBSD"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
target {
|
||||||
|
"iqn.2012-06.com.example:target0" {
|
||||||
|
alias = "Example target"
|
||||||
|
auth-group = no-authentication
|
||||||
|
lun = [
|
||||||
|
{ number = 0, name = example_0 },
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
"iqn.2012-06.com.example:target1" {
|
||||||
|
auth-group = ag0
|
||||||
|
portal-group { name = pg0 }
|
||||||
|
lun = [
|
||||||
|
{ number = 0, name = example_1 },
|
||||||
|
{ number = 1, name = example_2 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
naa.50015178f369f092 {
|
||||||
|
port = isp0
|
||||||
|
lun = [
|
||||||
|
{ number = 0, name = example_1 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.Ed
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr ctl 4 ,
|
.Xr ctl 4 ,
|
||||||
.Xr ctladm 8 ,
|
.Xr ctladm 8 ,
|
||||||
|
@ -27,7 +27,7 @@
|
|||||||
.\"
|
.\"
|
||||||
.\" $FreeBSD$
|
.\" $FreeBSD$
|
||||||
.\"
|
.\"
|
||||||
.Dd May 22, 2015
|
.Dd July 21, 2016
|
||||||
.Dt CTLD 8
|
.Dt CTLD 8
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
@ -37,6 +37,7 @@
|
|||||||
.Nm
|
.Nm
|
||||||
.Op Fl d
|
.Op Fl d
|
||||||
.Op Fl f Ar config-file
|
.Op Fl f Ar config-file
|
||||||
|
.Op Fl u
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
The
|
The
|
||||||
.Nm
|
.Nm
|
||||||
@ -84,6 +85,8 @@ The daemon sends verbose debug output to standard error, and does not
|
|||||||
put itself in the background.
|
put itself in the background.
|
||||||
The daemon will also not fork and will exit after processing one connection.
|
The daemon will also not fork and will exit after processing one connection.
|
||||||
This option is only intended for debugging the target.
|
This option is only intended for debugging the target.
|
||||||
|
.It Fl u
|
||||||
|
Use UCL configuration file format instead of the traditional non-UCL format.
|
||||||
.El
|
.El
|
||||||
.Sh FILES
|
.Sh FILES
|
||||||
.Bl -tag -width ".Pa /var/run/ctld.pid" -compact
|
.Bl -tag -width ".Pa /var/run/ctld.pid" -compact
|
||||||
|
Loading…
Reference in New Issue
Block a user