Debian Codegraph @

doc/config-schema.json.in

raw
1 {
2 "$schema": "https://json-schema.org/draft/2020-12/schema",
3 "$id": "https://github.com/linux-nvme/libnvme/doc/config-schema.json",
4 "title": "config.json",
5 "description": "libnvme JSON configuration",
6 "type": "object",
7 "properties": {
8 "hosts": {
9 "description": "Array of NVMe Host properties",
10 "type": "array",
11 "items": { "$ref": "#/$defs/host" }
12 }
13 },
14 "$defs": {
15 "host": {
16 "description": "NVMe Host properties",
17 "type": "object",
18 "properties": {
19 "hostnqn": {
20 "description": "NVMe host NQN",
21 "type": "string",
22 "maxLength": 223
23 },
24 "hostid": {
25 "description": "NVMe host ID",
26 "type": "string"
27 },
28 "dhchap_key": {
29 "description": "Host DH-HMAC-CHAP key",
30 "type": "string"
31 },
32 "hostsymname": {
33 "description": "NVMe host symbolic name",
34 "type": "string"
35 },
36 "persistent_discovery_ctrl": {
37 "description": "Enable/disable Persistent Discovery Controller",
38 "type": "boolean"
39 },
40 "required": [ "hostnqn" ],
41 "subsystems": {
42 "description": "Array of NVMe subsystem properties",
43 "type": "array",
44 "items": { "$ref": "#/$defs/subsystem" }
45 }
46 }
47 },
48 "subsystem": {
49 "description": "NVMe subsystem properties",
50 "type": "object",
51 "properties": {
52 "nqn": {
53 "description": "Subsystem NQN",
54 "type": "string",
55 "maxLength": 223
56 },
57 "ports": {
58 "description": "Array of NVMe subsystem ports",
59 "type": "array",
60 "items": { "$ref": "#/$defs/port" }
61 },
62 "application": {
63 "description": "Program managing this subsystem",
64 "type": "string"
65 },
66 "required": [ "nqn" ]
67 }
68 },
69 "port": {
70 "description": "NVMe subsystem port",
71 "type": "object",
72 "properties": {
73 "transport": {
74 "description": "Transport type",
75 "type": "string"
76 },
77 "traddr": {
78 "description": "Transport address",
79 "type": "string"
80 },
81 "host_traddr": {
82 "description": "Host transport address",
83 "type": "string"
84 },
85 "host_iface": {
86 "description": "Host interface name",
87 "type": "string"
88 },
89 "trsvcid": {
90 "description": "Transport service identifier",
91 "type": "string"
92 },
93 "dhchap_key": {
94 "description": "Host DH-HMAC-CHAP key",
95 "type": "string"
96 },
97 "dhchap_ctrl_key": {
98 "description": "Controller DH-HMAC-CHAP key",
99 "type": "string"
100 },
101 "keyring": {
102 "description": "Keyring for TLS key lookup",
103 "type": "string"
104 },
105 "tls_key_identity": {
106 "description": "PSK identity for the TLS PSK (tls_key)",
107 "type": "string"
108 },
109 "tls_key": {
110 "description": "TLS PSK in PSK interchange format",
111 "type": "string"
112 },
113 "nr_io_queues": {
114 "description": "Number of I/O queues",
115 "type": "integer"
116 },
117 "nr_write_queues": {
118 "description": "Number of write queues",
119 "type": "integer"
120 },
121 "nr_poll_queues": {
122 "description": "Number of poll queues",
123 "type": "integer"
124 },
125 "queue_size": {
126 "description": "Queue size",
127 "type": "integer"
128 },
129 "keep_alive_tmo": {
130 "description": "Keep-Alive timeout (in seconds)",
131 "type": "integer"
132 },
133 "reconnect_delay": {
134 "description": "Reconnect delay (in seconds)",
135 "type": "integer"
136 },
137 "ctrl_loss_tmo": {
138 "description": "Controller loss timeout (in seconds)",
139 "type": "integer"
140 },
141 "fast_io_fail_tmo": {
142 "description": "Fast I/O Fail timeout (in seconds)",
143 "type": "integer",
144 "default": 600
145 },
146 "tos": {
147 "description": "Type of service",
148 "type": "integer",
149 "default": -1
150 },
151 "duplicate_connect": {
152 "description": "Allow duplicate connections",
153 "type": "boolean",
154 "default": false
155 },
156 "disable_sqflow": {
157 "description": "Explicitly disable SQ flow control",
158 "type": "boolean",
159 "default": false
160 },
161 "hdr_digest": {
162 "description": "Enable header digest",
163 "type": "boolean",
164 "default": false
165 },
166 "data_digest": {
167 "description": "Enable data digest",
168 "type": "boolean",
169 "default": false
170 },
171 "tls": {
172 "description": "Enable TLS encryption",
173 "type": "boolean",
174 "default": false
175 },
176 "concat": {
177 "description": "Enable secure concatenation",
178 "type": "boolean",
179 "default": false
180 },
181 "persistent": {
182 "description": "Create persistent discovery connection",
183 "type": "boolean"
184 },
185 "discovery": {
186 "description": "Connect to a discovery controller",
187 "type": "boolean"
188 }
189 },
190 "required": [ "transport" ]
191 }
192 }
193 }