/
api_design_logical_devices.go
495 lines (441 loc) · 13 KB
/
api_design_logical_devices.go
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
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
package apstra
import (
"context"
"fmt"
"math"
"net/http"
"strconv"
"strings"
"time"
)
const (
apiUrlDesignLogicalDevices = apiUrlDesignPrefix + "logical-devices"
apiUrlDesignLogicalDevicesPrefix = apiUrlDesignLogicalDevices + apiUrlPathDelim
apiUrlDesignLogicalDeviceById = apiUrlDesignLogicalDevicesPrefix + "%s"
PortIndexingVerticalFirst = "L-R, T-B"
PortIndexingHorizontalFirst = "T-B, L-R"
PortIndexingSchemaAbsolute = "absolute"
)
type LogicalDevicePortRoleFlags uint16
type logicalDevicePortRole string
// class PortGroupSchema (scotch/schemas/logical_device.py) specifies:
// validate=validate.OneOf(
//
// ['spine', 'superspine', 'leaf', 'access',
// 'l3_server', 'peer', 'unused', 'generic']
const (
LogicalDevicePortRoleSpine = LogicalDevicePortRoleFlags(1 << iota)
LogicalDevicePortRoleSuperspine
LogicalDevicePortRoleLeaf
LogicalDevicePortRoleAccess
LogicalDevicePortRoleL3Server
LogicalDevicePortRolePeer
LogicalDevicePortRoleUnused
LogicalDevicePortRoleGeneric
LogicalDevicePortRoleUnknown = "unknown logical device port role '%s'"
logicalDevicePortRoleSpine = logicalDevicePortRole("spine")
logicalDevicePortRoleSuperspine = logicalDevicePortRole("superspine")
logicalDevicePortRoleLeaf = logicalDevicePortRole("leaf")
logicalDevicePortRoleAccess = logicalDevicePortRole("access")
logicalDevicePortRoleL3Server = logicalDevicePortRole("l3_server")
logicalDevicePortRolePeer = logicalDevicePortRole("peer")
logicalDevicePortRoleUnused = logicalDevicePortRole("unused")
logicalDevicePortRoleGeneric = logicalDevicePortRole("generic")
)
func (o *LogicalDevicePortRoleFlags) raw() []logicalDevicePortRole {
// instantiate as zero-length rather than nil so we send "[]"
// rather than "null" when no roles are specified.
result := make([]logicalDevicePortRole, 0)
if *o&LogicalDevicePortRoleSpine != 0 {
result = append(result, logicalDevicePortRoleSpine)
}
if *o&LogicalDevicePortRoleSuperspine != 0 {
result = append(result, logicalDevicePortRoleSuperspine)
}
if *o&LogicalDevicePortRoleLeaf != 0 {
result = append(result, logicalDevicePortRoleLeaf)
}
if *o&LogicalDevicePortRoleAccess != 0 {
result = append(result, logicalDevicePortRoleAccess)
}
if *o&LogicalDevicePortRoleL3Server != 0 {
result = append(result, logicalDevicePortRoleL3Server)
}
if *o&LogicalDevicePortRolePeer != 0 {
result = append(result, logicalDevicePortRolePeer)
}
if *o&LogicalDevicePortRoleUnused != 0 {
result = append(result, logicalDevicePortRoleUnused)
}
if *o&LogicalDevicePortRoleGeneric != 0 {
result = append(result, logicalDevicePortRoleGeneric)
}
return result
}
func (o *LogicalDevicePortRoleFlags) Strings() []string {
var result []string
for _, role := range o.raw() {
result = append(result, string(role))
}
return result
}
func (o *LogicalDevicePortRoleFlags) FromStrings(in []string) error {
*o = 0
for _, s := range in {
f, err := logicalDevicePortRole(s).parse()
if err != nil {
return err
}
*o = *o | f
}
return nil
}
func (o *LogicalDevicePortRoleFlags) SetAll() {
*o = LogicalDevicePortRoleFlags(math.MaxUint16)
}
func (o logicalDevicePortRole) parse() (LogicalDevicePortRoleFlags, error) {
switch o {
case logicalDevicePortRoleSpine:
return LogicalDevicePortRoleSpine, nil
case logicalDevicePortRoleSuperspine:
return LogicalDevicePortRoleSuperspine, nil
case logicalDevicePortRoleLeaf:
return LogicalDevicePortRoleLeaf, nil
case logicalDevicePortRoleAccess:
return LogicalDevicePortRoleAccess, nil
case logicalDevicePortRoleL3Server:
return LogicalDevicePortRoleL3Server, nil
case logicalDevicePortRolePeer:
return LogicalDevicePortRolePeer, nil
case logicalDevicePortRoleUnused:
return LogicalDevicePortRoleUnused, nil
case logicalDevicePortRoleGeneric:
return LogicalDevicePortRoleGeneric, nil
default:
return 0, fmt.Errorf(LogicalDevicePortRoleUnknown, o)
}
}
type logicalDevicePortRoles []logicalDevicePortRole
func (o logicalDevicePortRoles) parse() (LogicalDevicePortRoleFlags, error) {
var result LogicalDevicePortRoleFlags
for _, r := range o {
roleFlag, err := r.parse()
if err != nil {
return result, err
}
result = result | roleFlag
}
return result, nil
}
type optionsLogicalDevicesResponse struct {
Items []ObjectId `json:"items"`
Methods []string `json:"methods"`
}
type getLogicalDevicesResponse struct {
Items []rawLogicalDevice `json:"items"`
}
type LogicalDeviceData struct {
DisplayName string
Panels []LogicalDevicePanel
}
func (o *LogicalDeviceData) raw() *rawLogicalDeviceData {
panels := make([]rawLogicalDevicePanel, len(o.Panels))
for i := range o.Panels {
panels[i] = *o.Panels[i].raw()
}
return &rawLogicalDeviceData{
DisplayName: o.DisplayName,
Panels: panels,
}
}
type rawLogicalDeviceData struct {
DisplayName string `json:"display_name"`
Panels []rawLogicalDevicePanel `json:"panels"`
}
type LogicalDevicePanelLayout struct {
RowCount int `json:"row_count"`
ColumnCount int `json:"column_count"`
}
type LogicalDevicePortIndexing struct {
Order string `json:"order"`
StartIndex int `json:"start_index"`
Schema string `json:"schema"` // Valid choices: absolute
}
type LogicalDevicePortGroup struct {
Count int `json:"count"`
Speed LogicalDevicePortSpeed `json:"speed"`
Roles LogicalDevicePortRoleFlags `json:"roles"`
}
func (o LogicalDevicePortGroup) raw() *rawLogicalDevicePortGroup {
return &rawLogicalDevicePortGroup{
Count: o.Count,
Speed: *o.Speed.raw(),
Roles: o.Roles.raw(),
}
}
type rawLogicalDevicePortGroup struct {
Count int `json:"count"`
Speed rawLogicalDevicePortSpeed `json:"speed"`
Roles logicalDevicePortRoles `json:"roles"`
}
func (o *rawLogicalDevicePortGroup) parse() (*LogicalDevicePortGroup, error) {
roles, err := o.Roles.parse()
if err != nil {
return nil, err
}
return &LogicalDevicePortGroup{
Count: o.Count,
Speed: o.Speed.parse(),
Roles: roles,
}, nil
}
type LogicalDevicePortSpeed string
func (o LogicalDevicePortSpeed) raw() *rawLogicalDevicePortSpeed {
if o == "" {
return nil
}
defaultSpeed := rawLogicalDevicePortSpeed{
Unit: "G",
Value: 1,
}
lower := strings.ToLower(string(o))
lower = strings.TrimSpace(lower)
lower = strings.TrimSuffix(lower, "bps")
lower = strings.TrimSuffix(lower, "b/s")
var factor int64
var trimmed string
switch {
case strings.HasSuffix(lower, "m"):
trimmed = strings.TrimSuffix(lower, "m")
factor = 1000 * 1000
case strings.HasSuffix(lower, "g"):
trimmed = strings.TrimSuffix(lower, "g")
factor = 1000 * 1000 * 1000
case strings.HasSuffix(lower, "t"):
trimmed = strings.TrimSuffix(lower, "t")
factor = 1000 * 1000 * 1000 * 1000
default:
trimmed = lower
factor = 1
}
trimmedInt, err := strconv.ParseInt(trimmed, 10, 64)
if err != nil {
return &defaultSpeed
}
bps := trimmedInt * factor
switch {
case bps >= 1000*1000*1000: // at least 1Gbps
return &rawLogicalDevicePortSpeed{
Unit: "G",
Value: int(bps / 1000 / 1000 / 1000),
}
case bps >= 10*1000*1000: // at least 10Mbps
return &rawLogicalDevicePortSpeed{
Unit: "M",
Value: int(bps / 1000 / 1000),
}
default:
return &defaultSpeed
}
}
func (o LogicalDevicePortSpeed) BitsPerSecond() int64 {
return o.raw().BitsPerSecond()
}
func (o LogicalDevicePortSpeed) IsEqual(in LogicalDevicePortSpeed) bool {
return o.BitsPerSecond() == in.BitsPerSecond()
}
type rawLogicalDevicePortSpeed struct {
Unit string `json:"unit"`
Value int `json:"value"`
}
func (o rawLogicalDevicePortSpeed) parse() LogicalDevicePortSpeed {
return LogicalDevicePortSpeed(fmt.Sprintf("%d%s", o.Value, o.Unit))
}
func (o *rawLogicalDevicePortSpeed) BitsPerSecond() int64 {
switch o.Unit {
case "M":
return int64(o.Value * 1000 * 1000)
case "G":
return int64(o.Value * 1000 * 1000 * 1000)
default:
return int64(0)
}
}
type LogicalDevicePanel struct {
PanelLayout LogicalDevicePanelLayout `json:"panel_layout"`
PortIndexing LogicalDevicePortIndexing `json:"port_indexing"`
PortGroups []LogicalDevicePortGroup `json:"port_groups"`
}
func (o LogicalDevicePanel) raw() *rawLogicalDevicePanel {
var portGroups []rawLogicalDevicePortGroup
for _, pg := range o.PortGroups {
portGroups = append(portGroups, *pg.raw())
}
return &rawLogicalDevicePanel{
PanelLayout: o.PanelLayout,
PortIndexing: o.PortIndexing,
PortGroups: portGroups,
}
}
type rawLogicalDevicePanel struct {
PanelLayout LogicalDevicePanelLayout `json:"panel_layout"`
PortIndexing LogicalDevicePortIndexing `json:"port_indexing"`
PortGroups []rawLogicalDevicePortGroup `json:"port_groups"`
}
func (o rawLogicalDevicePanel) parse() (*LogicalDevicePanel, error) {
var portGroups []LogicalDevicePortGroup
for _, pg := range o.PortGroups {
p, err := pg.parse()
if err != nil {
return nil, err
}
portGroups = append(portGroups, *p)
}
return &LogicalDevicePanel{
PanelLayout: o.PanelLayout,
PortIndexing: o.PortIndexing,
PortGroups: portGroups,
}, nil
}
type LogicalDevice struct {
Id ObjectId
CreatedAt *time.Time
LastModifiedAt *time.Time
Data *LogicalDeviceData
}
func (o LogicalDevice) raw() *rawLogicalDevice {
var panels []rawLogicalDevicePanel
for _, panel := range o.Data.Panels {
panels = append(panels, *panel.raw())
}
return &rawLogicalDevice{
DisplayName: o.Data.DisplayName,
Id: o.Id,
Panels: panels,
CreatedAt: o.CreatedAt,
LastModifiedAt: o.LastModifiedAt,
}
}
type rawLogicalDevice struct {
DisplayName string `json:"display_name"`
Id ObjectId `json:"id,omitempty"`
Panels []rawLogicalDevicePanel `json:"panels"`
CreatedAt *time.Time `json:"created_at,omitempty"`
LastModifiedAt *time.Time `json:"last_modified_at,omitempty"`
}
func (o rawLogicalDevice) polish() (*LogicalDevice, error) {
panels := make([]LogicalDevicePanel, len(o.Panels))
for i, panel := range o.Panels {
parsed, err := panel.parse()
if err != nil {
return nil, err
}
panels[i] = *parsed
}
return &LogicalDevice{
Id: o.Id,
CreatedAt: o.CreatedAt,
LastModifiedAt: o.LastModifiedAt,
Data: &LogicalDeviceData{
DisplayName: o.DisplayName,
Panels: panels,
},
}, nil
}
func (o *Client) listLogicalDeviceIds(ctx context.Context) ([]ObjectId, error) {
response := &optionsLogicalDevicesResponse{}
err := o.talkToApstra(ctx, &talkToApstraIn{
method: http.MethodOptions,
urlStr: apiUrlDesignLogicalDevices,
apiResponse: response,
})
if err != nil {
return nil, convertTtaeToAceWherePossible(err)
}
return response.Items, nil
}
func (o *Client) getAllLogicalDevices(ctx context.Context) ([]LogicalDevice, error) {
response := &getLogicalDevicesResponse{}
err := o.talkToApstra(ctx, &talkToApstraIn{
method: http.MethodGet,
urlStr: apiUrlDesignLogicalDevices,
apiResponse: response,
})
if err != nil {
return nil, convertTtaeToAceWherePossible(err)
}
var result []LogicalDevice
for _, raw := range response.Items {
ld, err := raw.polish()
if err != nil {
return nil, err
}
result = append(result, *ld)
}
return result, nil
}
func (o *Client) getLogicalDevice(ctx context.Context, id ObjectId) (*rawLogicalDevice, error) {
response := &rawLogicalDevice{}
err := o.talkToApstra(ctx, &talkToApstraIn{
method: http.MethodGet,
urlStr: fmt.Sprintf(apiUrlDesignLogicalDeviceById, id),
apiResponse: response,
})
if err != nil {
return nil, convertTtaeToAceWherePossible(err)
}
return response, nil
}
func (o *Client) getLogicalDeviceByName(ctx context.Context, name string) (*LogicalDevice, error) {
logicalDevices, err := o.getAllLogicalDevices(ctx)
if err != nil {
return nil, err
}
var result LogicalDevice
var found bool
for _, ld := range logicalDevices {
if ld.Data.DisplayName == name {
if found {
return nil, ClientErr{
errType: ErrMultipleMatch,
err: fmt.Errorf("found multiple logical devices named '%s' found", name),
}
}
result = ld
found = true
}
}
if found {
return &result, nil
}
return nil, ClientErr{
errType: ErrNotfound,
err: fmt.Errorf("no logical device named '%s' found", name),
}
}
func (o *Client) createLogicalDevice(ctx context.Context, in *rawLogicalDeviceData) (ObjectId, error) {
response := &objectIdResponse{}
err := o.talkToApstra(ctx, &talkToApstraIn{
method: http.MethodPost,
urlStr: apiUrlDesignLogicalDevices,
apiInput: in,
apiResponse: response,
})
if err != nil {
return "", convertTtaeToAceWherePossible(err)
}
return response.Id, nil
}
func (o *Client) updateLogicalDevice(ctx context.Context, id ObjectId, in *rawLogicalDeviceData) error {
return o.talkToApstra(ctx, &talkToApstraIn{
method: http.MethodPut,
urlStr: fmt.Sprintf(apiUrlDesignLogicalDeviceById, id),
apiInput: in,
})
}
func (o *Client) deleteLogicalDevice(ctx context.Context, id ObjectId) error {
return o.talkToApstra(ctx, &talkToApstraIn{
method: http.MethodDelete,
urlStr: fmt.Sprintf(apiUrlDesignLogicalDeviceById, id),
})
}