MFC r303132:

Add documentation for "ctld -u", the UCL configuration file format.

Submitted by:	jceel@
Approved by:	re (kib)
MFC after:	1 month
Differential Revision:	https://reviews.freebsd.org/D7222

1 files changed, 92 insertions, 1 deletions

diff --git a/usr.sbin/ctld/ctl.conf.5 b/usr.sbin/ctld/ctl.conf.5
index cb624c5..ce26abc 100644
--- a/usr.sbin/ctld/ctl.conf.5
+++ b/usr.sbin/ctld/ctl.conf.5
@@ -28,7 +28,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 9, 2015
+.Dd July 21, 2016
 .Dt CTL.CONF 5
 .Os
 .Sh NAME
@@ -481,6 +481,97 @@ target naa.50015178f369f092 {
 	lun 0 example_1
 }
 .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
 .Xr ctl 4 ,
 .Xr ctladm 8 ,