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