auth.spec.pre.in 11.9 KB
Newer Older
1
{
Jelte Jansen's avatar
Jelte Jansen committed
2
  "module_spec": {
3
    "module_name": "Auth",
Jelte Jansen's avatar
Jelte Jansen committed
4
    "module_description": "Authoritative service",
5
    "config_data": [
6
      { "item_name": "database_file",
7
        "item_type": "string",
8
        "item_optional": true,
9
        "item_default": "@@LOCALSTATEDIR@@/@PACKAGE@/zone.sqlite3"
10
      },
11
      { "item_name": "datasources",
12 13 14
        "item_type": "list",
        "item_optional": true,
        "item_default": [],
Jelte Jansen's avatar
Jelte Jansen committed
15 16
        "list_item_spec":
        { "item_name": "list_element",
17
          "item_type": "map",
18
          "item_optional": false,
19
          "item_default": {},
Jelte Jansen's avatar
Jelte Jansen committed
20 21 22 23 24 25 26 27
          "map_item_spec": [
          { "item_name": "type",
            "item_type": "string",
            "item_optional": false,
            "item_default": ""
          },
          { "item_name": "class",
            "item_type": "string",
28
            "item_optional": false,
Jelte Jansen's avatar
Jelte Jansen committed
29 30 31 32 33 34 35 36 37 38
            "item_default": "IN"
          },
          { "item_name": "zones",
            "item_type": "list",
            "item_optional": false,
            "item_default": [],
            "list_item_spec":
            { "item_name": "list_element",
              "item_type": "map",
              "item_optional": true,
39
              "item_default": { "origin": "", "file": "" },
Jelte Jansen's avatar
Jelte Jansen committed
40 41 42 43 44 45 46 47 48 49
              "map_item_spec": [
              { "item_name": "origin",
                "item_type": "string",
                "item_optional": false,
                "item_default": ""
              },
              { "item_name": "file",
                "item_type": "string",
                "item_optional": false,
                "item_default": ""
50 51 52
              },
              { "item_name": "filetype",
                "item_type": "string",
53
                "item_optional": true
54
              }]
Jelte Jansen's avatar
Jelte Jansen committed
55 56
            }
          }]
57
        }
58
      },
59 60 61 62 63 64
      {
        "item_name": "listen_on",
        "item_type": "list",
        "item_optional": false,
        "item_default": [
          {
65
            "address": "::",
66
            "port": 53
67 68
          },
          {
69
            "address": "0.0.0.0",
70
            "port": 53
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
          }
        ],
        "list_item_spec": {
          "item_name": "address",
          "item_type": "map",
          "item_optional": false,
          "item_default": {},
          "map_item_spec": [
            {
              "item_name": "address",
              "item_type": "string",
              "item_optional": false,
              "item_default": "::1"
            },
            {
              "item_name": "port",
              "item_type": "integer",
              "item_optional": false,
89
              "item_default": 53
90 91 92
            }
          ]
        }
93 94 95 96
      },
      { "item_name": "tcp_recv_timeout",
        "item_type": "integer",
        "item_optional": false,
97
        "item_default": 5000
98
      }
99 100 101 102
    ],
    "commands": [
      {
        "command_name": "shutdown",
Jeremy C. Reed's avatar
Jeremy C. Reed committed
103
        "command_description": "Shut down authoritative DNS server",
104 105 106 107 108 109 110
        "command_args": [
          {
            "item_name": "pid",
            "item_type": "integer",
            "item_optional": true
          }
        ]
111 112
      },
      {
113 114
        "command_name": "getstats",
        "command_description": "Retrieve statistics data",
115
        "command_args": []
116 117 118
      },
      {
        "command_name": "loadzone",
JINMEI Tatuya's avatar
JINMEI Tatuya committed
119
        "command_description": "(Re)load a specified zone",
120 121 122 123 124 125 126 127 128 129
        "command_args": [
          {
            "item_name": "class", "item_type": "string",
            "item_optional": true, "item_default": "IN"
          },
	  {
            "item_name": "origin", "item_type": "string",
            "item_optional": false, "item_default": ""
          }
        ]
130 131 132
      },
      {
        "command_name": "start_ddns_forwarder",
Jelte Jansen's avatar
Jelte Jansen committed
133
        "command_description": "(Re)start internal forwarding of DDNS Update messages. This is automatically called if b10-ddns is started, and is not expected to be called by administrators; it will be removed as a public command in the future.",
134 135 136 137
        "command_args": []
      },
      {
        "command_name": "stop_ddns_forwarder",
Jelte Jansen's avatar
Jelte Jansen committed
138
        "command_description": "Stop internal forwarding of DDNS Update messages. This is automatically called if b10-ddns is stopped, and is not expected to be called by administrators; it will be removed as a public command in the future.",
139
        "command_args": []
140
      }
141 142 143 144 145 146 147
    ],
    "statistics": [
      {
        "item_name": "queries.tcp",
        "item_type": "integer",
        "item_optional": false,
        "item_default": 0,
148
        "item_title": "Queries TCP",
149 150 151 152 153 154 155 156 157
        "item_description": "A number of total query counts which all auth servers receive over TCP since they started initially"
      },
      {
        "item_name": "queries.udp",
        "item_type": "integer",
        "item_optional": false,
        "item_default": 0,
        "item_title": "Queries UDP",
        "item_description": "A number of total query counts which all auth servers receive over UDP since they started initially"
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
      },
      {
        "item_name": "opcode.query",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Received query requests",
        "item_description": "The number of total request counts whose opcode is query"
      },
      {
        "item_name": "opcode.iquery",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Received inverse query requests",
        "item_description": "The number of total request counts whose opcode is inverse query"
      },
      {
        "item_name": "opcode.status",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Received status requests",
        "item_description": "The number of total request counts whose opcode is status"
      },
      {
        "item_name": "opcode.notify",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Received notify requests",
        "item_description": "The number of total request counts whose opcode is notify"
      },
      {
        "item_name": "opcode.update",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Received update requests",
        "item_description": "The number of total request counts whose opcode is update"
      },
      {
200
        "item_name": "opcode.other",
201 202 203
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
204 205
        "item_title": "Received requests opcode other",
        "item_description": "The number of total request counts whose opcode is other (not well-known)"
Jelte Jansen's avatar
Jelte Jansen committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
      },
      {
        "item_name": "rcode.noerror",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent success response",
        "item_description": "The number of total responses with rcode 0 (NOERROR)"
      },
      {
        "item_name": "rcode.formerr",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'format error' response",
        "item_description": "The number of total responses with rcode 1 (FORMERR)"
      },
      {
        "item_name": "rcode.servfail",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'server failure' response",
        "item_description": "The number of total responses with rcode 2 (SERVFAIL)"
      },
      {
        "item_name": "rcode.nxdomain",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'name error' response",
        "item_description": "The number of total responses with rcode 3 (NXDOMAIN)"
      },
      {
        "item_name": "rcode.notimp",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'not implemented' response",
        "item_description": "The number of total responses with rcode 4 (NOTIMP)"
      },
      {
        "item_name": "rcode.refused",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'refused' response",
        "item_description": "The number of total responses with rcode 5 (REFUSED)"
      },
      {
        "item_name": "rcode.yxdomain",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'name unexpectedly exists' response",
        "item_description": "The number of total responses with rcode 6 (YXDOMAIN)"
      },
      {
        "item_name": "rcode.yxrrset",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'rrset unexpectedly exists' response",
        "item_description": "The number of total responses with rcode 7 (YXRRSET)"
      },
      {
        "item_name": "rcode.nxrrset",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'no such rrset' response",
277
        "item_description": "The number of total responses with rcode 8 (NXRRSET)"
Jelte Jansen's avatar
Jelte Jansen committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
      },
      {
        "item_name": "rcode.notauth",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'not authoritative' response",
        "item_description": "The number of total responses with rcode 9 (NOTAUTH)"
      },
      {
        "item_name": "rcode.notzone",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'name not in zone' response",
        "item_description": "The number of total responses with rcode 10 (NOTZONE)"
      },
      {
296
        "item_name": "rcode.badsigvers",
Jelte Jansen's avatar
Jelte Jansen committed
297 298 299
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
300 301
        "item_title": "Sent 'EDNS version not implemented' response",
        "item_description": "The number of total responses with rcode 16 (BADVERS)"
Jelte Jansen's avatar
Jelte Jansen committed
302 303
      },
      {
304
        "item_name": "rcode.badkey",
Jelte Jansen's avatar
Jelte Jansen committed
305 306 307
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
308 309
        "item_title": "Sent 'Key not recognized' response",
        "item_description": "The number of total responses with rcode 17 (BADKEY)"
Jelte Jansen's avatar
Jelte Jansen committed
310 311
      },
      {
312
        "item_name": "rcode.badtime",
Jelte Jansen's avatar
Jelte Jansen committed
313 314 315
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
316 317
        "item_title": "Sent 'Signature out of time window' response",
        "item_description": "The number of total responses with rcode 18 (BADTIME)"
Jelte Jansen's avatar
Jelte Jansen committed
318 319
      },
      {
320
        "item_name": "rcode.badmode",
Jelte Jansen's avatar
Jelte Jansen committed
321 322 323
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
324 325
        "item_title": "Sent 'Bad TKEY Mode' response",
        "item_description": "The number of total responses with rcode 19 (BADMODE)"
Jelte Jansen's avatar
Jelte Jansen committed
326 327
      },
      {
328
        "item_name": "rcode.badname",
Jelte Jansen's avatar
Jelte Jansen committed
329 330 331
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
332 333
        "item_title": "Sent 'Duplicate key name' response",
        "item_description": "The number of total responses with rcode 20 (BADNAME)"
Jelte Jansen's avatar
Jelte Jansen committed
334 335
      },
      {
336
        "item_name": "rcode.badalg",
Jelte Jansen's avatar
Jelte Jansen committed
337 338 339
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
        "item_title": "Sent 'Algorithm not supported' response",
        "item_description": "The number of total responses with rcode 21 (BADALG)"
      },
      {
        "item_name": "rcode.badtrunc",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent 'Bad Truncation' response",
        "item_description": "The number of total responses with rcode 22 (BADTRUNC)"
      },
      {
        "item_name": "rcode.other",
        "item_type": "integer",
        "item_optional": true,
        "item_default": 0,
        "item_title": "Sent responses with rcode other",
        "item_description": "The number of total responses with rcode other (not well-known)"
358
      }
359
    ]
360 361
  }
}