xref: /illumos-gate/usr/src/cmd/isns/isnsd/xml_def/isnsdata.dtd.1 (revision 257873cfc1dd3337766407f80397db60a56f2f5a)
1<?xml version='1.0' encoding='UTF-8'?>
2
3<!--
4
5CDDL HEADER START
6
7The contents of this file are subject to the terms of the
8Common Development and Distribution License (the "License").
9You may not use this file except in compliance with the License.
10
11You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
12or http://www.opensolaris.org/os/licensing.
13See the License for the specific language governing permissions
14and limitations under the License.
15
16When distributing Covered Code, include this CDDL HEADER in each
17file and include the License file at usr/src/OPENSOLARIS.LICENSE.
18If applicable, add the following below this CDDL HEADER, with the
19fields enclosed by brackets "[]" replaced with your own identifying
20information: Portions Copyright [yyyy] [name of copyright owner]
21
22CDDL HEADER END
23
24Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
25Use is subject to license terms.
26
27
28iSNS Server persistent data store document type definition
29
30-->
31
32<!--
33	This file contains the DTD for the XML flat file of iSNS
34	Persistent Data Store. It defines the XML Nodes and format
35	of iSNS Objects and iSNS Attributes of the Objects.
36
37	There are six iSNS Objects: Network Entity, Portal, iSCSI
38	Storage Node, Portal Group, Discovery Domain Set and
39	Discovery Domain. Each object will be defined as a XML Node.
40
41	All of UID attribute and Key attributes of each iSNS Object
42	will be defined as attributes of a XML Node. Other iSNS
43	Attributes of each iSNS Object will be defined as child
44	elements of the XML Node.
45-->
46
47<!--
48	Root Node Of The Persistent Data Store
49-->
50
51<!ELEMENT isns_data (entity*, dd*, dds*)>
52<!ATTLIST isns_data vendor   CDATA #REQUIRED
53		    version  CDATA #REQUIRED>
54
55<!--
56	Network Entity Object
57-->
58
59<!ELEMENT entity (protocol, period?,
60		  (iscsi | portal)+, pg*)>
61<!-- 7: Entity Index -->
62<!-- 1: Entity Identifier (EID) -->
63<!ATTLIST entity uid   CDATA #REQUIRED
64		 eid   CDATA #REQUIRED>
65<!-- 2: Entity Protocol -->
66<!ELEMENT protocol (#PCDATA)>
67<!-- 6: Registration Period -->
68<!ELEMENT period (#PCDATA)>
69
70<!--
71	Portal Object
72-->
73
74<!ELEMENT portal (esi?, scn?)>
75<!-- 22: Portal Index -->
76<!-- 16: Portal IP Address -->
77<!-- 17: Portal TCP/UDP Port -->
78<!ATTLIST portal uid    CDATA #REQUIRED
79		 ip     CDATA #REQUIRED
80		 port   CDATA #REQUIRED>
81<!-- 20: ESI Port -->
82<!ELEMENT esi (#PCDATA)>
83<!-- 23: SCN Port -->
84<!ELEMENT scn (#PCDATA)>
85
86<!--
87	iSCSI Storage Node Object
88-->
89
90<!ELEMENT iscsi (type, alias?, auth?)>
91<!-- 36: iSCSI Node Index -->
92<!-- 32: iSCSI Name -->
93<!ATTLIST iscsi  uid    CDATA #REQUIRED
94		 name   CDATA #REQUIRED>
95<!-- 33: iSCSI Node Type -->
96<!ELEMENT type (#PCDATA)>
97<!-- 34: iSCSI Alias -->
98<!ELEMENT alias (#PCDATA)>
99<!-- 42: iSCSI AuthMethod -->
100<!ELEMENT auth (#PCDATA)>
101
102<!--
103	Portal Group Object
104-->
105
106<!ELEMENT pg (pgt)>
107<!-- 52: PG Index -->
108<!-- 48: PG iSCSI Name -->
109<!-- 49: PG Portal IP Addr -->
110<!-- 50: PG Portal TCP/UDP Port -->
111<!ATTLIST pg     uid        CDATA #REQUIRED
112		 pg_iscsi   CDATA #REQUIRED
113		 pg_ip      CDATA #REQUIRED
114		 pg_port    CDATA #REQUIRED>
115<!-- 51: PG Tag (PGT) -->
116<!ELEMENT pgt (#PCDATA)>
117
118<!--
119	Discovery Domain Set Object
120-->
121
122<!ELEMENT dds (status?, assoc_dd*)>
123<!-- 2049: DD_Set ID -->
124<!-- 2050: DD_Set Sym Name -->
125<!ATTLIST dds    uid    CDATA #REQUIRED
126		 name   CDATA #REQUIRED>
127<!-- 2051: DD_Set Status -->
128<!ELEMENT status (#PCDATA)>
129
130<!--
131	DD_DDS Association object
132-->
133
134<!ELEMENT assoc_dd EMPTY>
135<!-- 2065: DD_ID -->
136<!ATTLIST assoc_dd dd_uid    CDATA #REQUIRED>
137
138<!--
139	Discovery Domain Object
140-->
141
142<!ELEMENT dd (features?, assoc_iscsi*)>
143<!-- 2065: DD_ID -->
144<!-- 2066: DD_Symbolic Name -->
145<!ATTLIST dd     uid     CDATA #REQUIRED
146		 name    CDATA #REQUIRED>
147<!-- 2078: DD_Features -->
148<!ELEMENT features (#PCDATA)>
149
150<!--
151	ISCSI_DD Association object
152-->
153
154<!ELEMENT assoc_iscsi EMPTY>
155<!-- 36: iSCSI Node Index -->
156<!-- 32: iSCSI Name -->
157<!ATTLIST assoc_iscsi iscsi_uid    CDATA #REQUIRED
158		      iscsi_name   CDATA #REQUIRED>
159