/
resource_iosxe_interface_loopback.go
459 lines (410 loc) · 18 KB
/
resource_iosxe_interface_loopback.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
// Copyright © 2023 Cisco Systems, Inc. and its affiliates.
// All rights reserved.
//
// Licensed under the Mozilla Public License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://mozilla.org/MPL/2.0/
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: MPL-2.0
// Code generated by "gen/generator.go"; DO NOT EDIT.
package provider
import (
"context"
"fmt"
"regexp"
"github.com/CiscoDevNet/terraform-provider-iosxe/internal/provider/helpers"
"github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/int64planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-log/tflog"
"github.com/netascode/go-restconf"
)
func NewInterfaceLoopbackResource() resource.Resource {
return &InterfaceLoopbackResource{}
}
type InterfaceLoopbackResource struct {
clients map[string]*restconf.Client
}
func (r *InterfaceLoopbackResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_interface_loopback"
}
func (r *InterfaceLoopbackResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
// This description is used by the documentation generator and the language server.
MarkdownDescription: "This resource can manage the Interface Loopback configuration.",
Attributes: map[string]schema.Attribute{
"device": schema.StringAttribute{
MarkdownDescription: "A device name from the provider configuration.",
Optional: true,
},
"id": schema.StringAttribute{
MarkdownDescription: "The path of the object.",
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"delete_mode": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is `all`.").AddStringEnumDescription("all", "attributes").String,
Optional: true,
Validators: []validator.String{
stringvalidator.OneOf("all", "attributes"),
},
},
"name": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("").AddIntegerRangeDescription(0, 2147483647).String,
Required: true,
Validators: []validator.Int64{
int64validator.Between(0, 2147483647),
},
PlanModifiers: []planmodifier.Int64{
int64planmodifier.RequiresReplace(),
},
},
"description": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Interface specific description").String,
Optional: true,
Validators: []validator.String{
stringvalidator.LengthBetween(0, 200),
stringvalidator.RegexMatches(regexp.MustCompile(`.*`), ""),
},
},
"shutdown": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Shutdown the selected interface").String,
Optional: true,
},
"ip_proxy_arp": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Enable proxy ARP").String,
Optional: true,
},
"ip_redirects": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Enable sending ICMP Redirect messages").String,
Optional: true,
},
"ip_unreachables": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Enable sending ICMP Unreachable messages").String,
Optional: true,
},
"vrf_forwarding": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Configure forwarding table").String,
Optional: true,
},
"ipv4_address": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Optional: true,
Validators: []validator.String{
stringvalidator.RegexMatches(regexp.MustCompile(`(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?`), ""),
},
},
"ipv4_address_mask": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Optional: true,
Validators: []validator.String{
stringvalidator.RegexMatches(regexp.MustCompile(`(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?`), ""),
},
},
"ip_access_group_in": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Optional: true,
},
"ip_access_group_in_enable": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("inbound packets").String,
Optional: true,
},
"ip_access_group_out": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Optional: true,
},
"ip_access_group_out_enable": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("outbound packets").String,
Optional: true,
},
"ipv6_enable": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Enable IPv6 on interface").String,
Optional: true,
},
"ipv6_mtu": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("Set IPv6 Maximum Transmission Unit").AddIntegerRangeDescription(1280, 9976).String,
Optional: true,
Validators: []validator.Int64{
int64validator.Between(1280, 9976),
},
},
"ipv6_nd_ra_suppress_all": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Suppress all IPv6 RA").String,
Optional: true,
},
"ipv6_address_autoconfig_default": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Insert default route").String,
Optional: true,
},
"ipv6_address_dhcp": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Obtain IPv6 address from DHCP server").String,
Optional: true,
},
"ipv6_link_local_addresses": schema.ListNestedAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Optional: true,
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"address": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Required: true,
Validators: []validator.String{
stringvalidator.RegexMatches(regexp.MustCompile(`((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(%[\p{N}\p{L}]+)?`), ""),
stringvalidator.RegexMatches(regexp.MustCompile(`(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?`), ""),
},
},
"link_local": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Use link-local address").String,
Optional: true,
},
},
},
},
"ipv6_addresses": schema.ListNestedAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Optional: true,
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"prefix": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("").String,
Required: true,
Validators: []validator.String{
stringvalidator.RegexMatches(regexp.MustCompile(`((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))`), ""),
stringvalidator.RegexMatches(regexp.MustCompile(`(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(/.+)`), ""),
},
},
"eui_64": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Use eui-64 interface identifier").String,
Optional: true,
},
},
},
},
"arp_timeout": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("Set ARP cache timeout").AddIntegerRangeDescription(0, 2147483).String,
Optional: true,
Validators: []validator.Int64{
int64validator.Between(0, 2147483),
},
},
},
}
}
func (r *InterfaceLoopbackResource) Configure(_ context.Context, req resource.ConfigureRequest, _ *resource.ConfigureResponse) {
if req.ProviderData == nil {
return
}
r.clients = req.ProviderData.(map[string]*restconf.Client)
}
func (r *InterfaceLoopbackResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
var plan InterfaceLoopback
// Read plan
diags := req.Plan.Get(ctx, &plan)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
if _, ok := r.clients[plan.Device.ValueString()]; !ok {
resp.Diagnostics.AddAttributeError(path.Root("device"), "Invalid device", fmt.Sprintf("Device '%s' does not exist in provider configuration.", plan.Device.ValueString()))
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Create", plan.getPath()))
// Create object
body := plan.toBody(ctx)
emptyLeafsDelete := plan.getEmptyLeafsDelete(ctx)
tflog.Debug(ctx, fmt.Sprintf("List of empty leafs to delete: %+v", emptyLeafsDelete))
if YangPatch {
edits := []restconf.YangPatchEdit{restconf.NewYangPatchEdit("merge", plan.getPath(), restconf.Body{Str: body})}
for _, i := range emptyLeafsDelete {
edits = append(edits, restconf.NewYangPatchEdit("remove", i, restconf.Body{}))
}
_, err := r.clients[plan.Device.ValueString()].YangPatchData("", "1", "", edits)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to configure object, got error: %s", err))
return
}
} else {
res, err := r.clients[plan.Device.ValueString()].PatchData(plan.getPathShort(), body)
if len(res.Errors.Error) > 0 && res.Errors.Error[0].ErrorMessage == "patch to a nonexistent resource" {
_, err = r.clients[plan.Device.ValueString()].PutData(plan.getPath(), body)
}
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to configure object (PATCH), got error: %s", err))
return
}
for _, i := range emptyLeafsDelete {
res, err := r.clients[plan.Device.ValueString()].DeleteData(i)
if err != nil && res.StatusCode != 404 {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object, got error: %s", err))
return
}
}
}
plan.Id = types.StringValue(plan.getPath())
tflog.Debug(ctx, fmt.Sprintf("%s: Create finished successfully", plan.getPath()))
diags = resp.State.Set(ctx, &plan)
resp.Diagnostics.Append(diags...)
}
func (r *InterfaceLoopbackResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
var state InterfaceLoopback
// Read state
diags := req.State.Get(ctx, &state)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
if _, ok := r.clients[state.Device.ValueString()]; !ok {
resp.Diagnostics.AddAttributeError(path.Root("device"), "Invalid device", fmt.Sprintf("Device '%s' does not exist in provider configuration.", state.Device.ValueString()))
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Read", state.Id.ValueString()))
res, err := r.clients[state.Device.ValueString()].GetData(state.Id.ValueString())
if res.StatusCode == 404 {
state = InterfaceLoopback{Device: state.Device, Id: state.Id}
} else {
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to retrieve object, got error: %s", err))
return
}
state.updateFromBody(ctx, res.Res)
}
tflog.Debug(ctx, fmt.Sprintf("%s: Read finished successfully", state.Id.ValueString()))
diags = resp.State.Set(ctx, &state)
resp.Diagnostics.Append(diags...)
}
func (r *InterfaceLoopbackResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
var plan, state InterfaceLoopback
// Read plan
diags := req.Plan.Get(ctx, &plan)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
// Read state
diags = req.State.Get(ctx, &state)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
if _, ok := r.clients[plan.Device.ValueString()]; !ok {
resp.Diagnostics.AddAttributeError(path.Root("device"), "Invalid device", fmt.Sprintf("Device '%s' does not exist in provider configuration.", plan.Device.ValueString()))
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Update", plan.Id.ValueString()))
body := plan.toBody(ctx)
deletedItems := plan.getDeletedItems(ctx, state)
tflog.Debug(ctx, fmt.Sprintf("Removed items to delete: %+v", deletedItems))
emptyLeafsDelete := plan.getEmptyLeafsDelete(ctx)
tflog.Debug(ctx, fmt.Sprintf("List of empty leafs to delete: %+v", emptyLeafsDelete))
if YangPatch {
edits := []restconf.YangPatchEdit{restconf.NewYangPatchEdit("merge", plan.getPath(), restconf.Body{Str: body})}
for _, i := range deletedItems {
edits = append(edits, restconf.NewYangPatchEdit("remove", i, restconf.Body{}))
}
for _, i := range emptyLeafsDelete {
edits = append(edits, restconf.NewYangPatchEdit("remove", i, restconf.Body{}))
}
_, err := r.clients[plan.Device.ValueString()].YangPatchData("", "1", "", edits)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to update object, got error: %s", err))
return
}
} else {
res, err := r.clients[plan.Device.ValueString()].PatchData(plan.getPathShort(), body)
if len(res.Errors.Error) > 0 && res.Errors.Error[0].ErrorMessage == "patch to a nonexistent resource" {
_, err = r.clients[plan.Device.ValueString()].PutData(plan.getPath(), body)
}
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to configure object (PATCH), got error: %s", err))
return
}
for _, i := range deletedItems {
res, err := r.clients[state.Device.ValueString()].DeleteData(i)
if err != nil && res.StatusCode != 404 {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object, got error: %s", err))
return
}
}
for _, i := range emptyLeafsDelete {
res, err := r.clients[plan.Device.ValueString()].DeleteData(i)
if err != nil && res.StatusCode != 404 {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object, got error: %s", err))
return
}
}
}
tflog.Debug(ctx, fmt.Sprintf("%s: Update finished successfully", plan.Id.ValueString()))
diags = resp.State.Set(ctx, &plan)
resp.Diagnostics.Append(diags...)
}
func (r *InterfaceLoopbackResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
var state InterfaceLoopback
// Read state
diags := req.State.Get(ctx, &state)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
if _, ok := r.clients[state.Device.ValueString()]; !ok {
resp.Diagnostics.AddAttributeError(path.Root("device"), "Invalid device", fmt.Sprintf("Device '%s' does not exist in provider configuration.", state.Device.ValueString()))
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Delete", state.Id.ValueString()))
deleteMode := "all"
if state.DeleteMode.ValueString() == "all" {
deleteMode = "all"
} else if state.DeleteMode.ValueString() == "attributes" {
deleteMode = "attributes"
}
if deleteMode == "all" {
res, err := r.clients[state.Device.ValueString()].DeleteData(state.Id.ValueString())
if err != nil && res.StatusCode != 404 && res.StatusCode != 400 {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object, got error: %s", err))
return
}
} else {
deletePaths := state.getDeletePaths(ctx)
tflog.Debug(ctx, fmt.Sprintf("Paths to delete: %+v", deletePaths))
if YangPatch {
edits := []restconf.YangPatchEdit{}
for _, i := range deletePaths {
edits = append(edits, restconf.NewYangPatchEdit("remove", i, restconf.Body{}))
}
_, err := r.clients[state.Device.ValueString()].YangPatchData("", "1", "", edits)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object, got error: %s", err))
return
}
} else {
for _, i := range deletePaths {
res, err := r.clients[state.Device.ValueString()].DeleteData(i)
if err != nil && res.StatusCode != 404 {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object, got error: %s", err))
return
}
}
}
}
tflog.Debug(ctx, fmt.Sprintf("%s: Delete finished successfully", state.Id.ValueString()))
resp.State.RemoveResource(ctx)
}
func (r *InterfaceLoopbackResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
}