forked from kimchi-project/ginger
-
Notifications
You must be signed in to change notification settings - Fork 0
/
API.json
232 lines (232 loc) · 8.15 KB
/
API.json
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
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
200
201
202
203
204
205
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
{
"$schema": "http://json-schema.org/draft-03/schema#",
"title": "Ginger Plugin API",
"description": "JSON schema for Ginger Plugin API",
"type": "object",
"properties": {
"firmware_update": {
"type": "object",
"properties": {
"path": {
"description": "The full path to the firmware archive",
"type": "string",
"required": true
},
"overwrite-perm-ok": {
"description": "Give permission to overwrite the permanent image area if necessary. Valid inputs: 'True'|'False' Default is True, if unspecified.",
"type": "boolean",
"required": false
}
}
},
"firmware_commit": {
"type": "null",
"properties": {
}
},
"firmware_reject": {
"type": "null",
"properties": {
}
},
"powerprofile_update": {
"type": "object",
"properties": {
"active": {
"description": "State of the profile",
"type": "boolean",
"required": true
}
}
},
"users_create": {
"type": "object",
"error": "GINUSER0001E",
"properties": {
"name": {
"description": "The login name of the new user",
"type": "string",
"required": true,
"error": "GINUSER0002E"
},
"password": {
"description": "The new user password",
"type": "string",
"required": true,
"error": "GINUSER0003E"
},
"group": {
"description": "The group name of the new user",
"type": "string",
"error": "GINUSER0004E"
},
"profile": {
"description": "The profile of the new user",
"type": "string",
"pattern": "^regularuser|virtuser|admin$",
"error": "GINUSER0005E"
},
"no_login": {
"description": "User with Shell or not",
"type": "boolean",
"error": "GINUSER0015E"
}
}
},
"network_update": {
"type": "object",
"properties": {
"nameservers": {
"description": "DNS Servers",
"type": "array",
"items": {
"type": "string",
"oneOf": [
{ "format": "host-name" },
{ "format": "ipv4" },
{ "format": "ipv6" }
]
},
"minItems": 1,
"uniqueItems": true,
"error": "GINNET0005E"
},
"gateway": {
"description": "Default network gateway",
"type": "string",
"format": "ip-address",
"error": "GINNET0008E"
}
}
},
"interface_update": {
"type": "object",
"properties": {
"ipaddr": {
"description": "Interface IP address",
"type": "string",
"required": true,
"error": "GINNET0006E"
},
"netmask": {
"description": "Interface netmask",
"type": "string",
"required": true,
"error": "GINNET0007E"
}
}
},
"archives_create": {
"type": "object",
"properties": {
"description": {
"description": "Comments for the archive",
"type": "string",
"maxLength": 4096,
"error": "GINHBK0004E"
},
"include": {
"description": "Array of paths or patterns to include.",
"type": "array",
"uniqueItems": true,
"error": "GINHBK0005E",
"items": {
"description": "Full path of a directory or file, or a pattern.",
"minLength": 1,
"maxLength": 1024,
"type": "string",
"error": "GINHBK0006E"
}
},
"exclude": {
"description": "Array of paths or patterns to exclude.",
"type": "array",
"uniqueItems": true,
"error": "GINHBK0005E",
"items": {
"description": "Full path of a directory or file, or a pattern.",
"minLength": 1,
"maxLength": 1024,
"type": "string",
"error": "GINHBK0006E"
}
}
}
},
"backup_discard_archives": {
"type": "object",
"properties": {
"days_ago": {
"description": "Discard all archives older than some days ago. -1 means don't count the days.",
"type": "integer",
"minimum": -1,
"maximum": 65535,
"required": true,
"error": "GINHBK0007E"
},
"counts_ago": {
"description": "Discard all archives older than some counts ago. -1 means don't count the counts.",
"type": "integer",
"minimum": -1,
"maximum": 65535,
"required": true,
"error": "GINHBK0008E"
}
}
},
"subscribers_create":{
"type": "object",
"error": "GINSEP0001E",
"properties": {
"hostname": {
"description": "Specifies the hostname of the system.",
"type": "string",
"required": true,
"error": "GINSEP0002E"
},
"port": {
"description": "Specifies the port of the system.",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"required": true,
"error": "GINSEP0003E"
},
"community": {
"description": "Specifies the SNMP community.",
"pattern": "^[^ ]+[^ ]*$",
"type": "string",
"required": true,
"error": "GINSEP0004E"
}
}
},
"subscription_update":{
"type": "object",
"error": "GINSEP0001E",
"properties": {
"hostname": {
"description": "Specifies the hostname of the system.",
"type": "string",
"required": true,
"error": "GINSEP0002E"
},
"port": {
"description": "Specifies the port of the system.",
"type": "integer",
"minimum": 1,
"maximum": 65535,
"required": true,
"error": "GINSEP0003E"
},
"community": {
"description": "Specifies the SNMP community.",
"pattern": "^[^ ]+[^ ]*$",
"type": "string",
"required": true,
"error": "GINSEP0004E"
}
}
}
}
}