svn commit: r303262 - stable/11/usr.sbin/ctld

[Edward Tomasz Napierala]

Author: trasz
Date: Sun Jul 24 10:00:29 2016
New Revision: 303262
URL: https://svnweb.freebsd.org/changeset/base/303262

Log:
  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

Modified:
  stable/11/usr.sbin/ctld/ctl.conf.5
  stable/11/usr.sbin/ctld/ctld.8
Directory Properties:
  stable/11/   (props changed)

Modified: stable/11/usr.sbin/ctld/ctl.conf.5
==============================================================================
--- stable/11/usr.sbin/ctld/ctl.conf.5	Sun Jul 24 09:15:11 2016	(r303261)
+++ stable/11/usr.sbin/ctld/ctl.conf.5	Sun Jul 24 10:00:29 2016	(r303262)
@@ -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 ,

Modified: stable/11/usr.sbin/ctld/ctld.8
==============================================================================
--- stable/11/usr.sbin/ctld/ctld.8	Sun Jul 24 09:15:11 2016	(r303261)
+++ stable/11/usr.sbin/ctld/ctld.8	Sun Jul 24 10:00:29 2016	(r303262)
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd May 22, 2015
+.Dd July 21, 2016
 .Dt CTLD 8
 .Os
 .Sh NAME
@@ -37,6 +37,7 @@
 .Nm
 .Op Fl d
 .Op Fl f Ar config-file
+.Op Fl u
 .Sh DESCRIPTION
 The
 .Nm
@@ -84,6 +85,8 @@ The daemon sends verbose debug output to
 put itself in the background.
 The daemon will also not fork and will exit after processing one connection.
 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
 .Sh FILES
 .Bl -tag -width ".Pa /var/run/ctld.pid" -compact