/
resource_nxos_ipv4_access_list_entry.go
451 lines (412 loc) · 21.7 KB
/
resource_nxos_ipv4_access_list_entry.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
// 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"
"github.com/CiscoDevNet/terraform-provider-nxos/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/booldefault"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/int64default"
"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/stringdefault"
"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-nxos"
)
// Ensure provider defined types fully satisfy framework interfaces
var _ resource.Resource = &IPv4AccessListEntryResource{}
var _ resource.ResourceWithImportState = &IPv4AccessListEntryResource{}
func NewIPv4AccessListEntryResource() resource.Resource {
return &IPv4AccessListEntryResource{}
}
type IPv4AccessListEntryResource struct {
clients map[string]*nxos.Client
}
func (r *IPv4AccessListEntryResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_ipv4_access_list_entry"
}
func (r *IPv4AccessListEntryResource) 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: helpers.NewResourceDescription("This resource can manage IPv4 Access List Entries.", "ipv4aclACE", "Security%20and%20Policing/ipv4acl:ACE/").AddParents("ipv4_access_list").String,
Attributes: map[string]schema.Attribute{
"device": schema.StringAttribute{
MarkdownDescription: "A device name from the provider configuration.",
Optional: true,
},
"id": schema.StringAttribute{
MarkdownDescription: "The distinguished name of the object.",
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"name": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Access list name.").String,
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
},
"sequence_number": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("Sequence number.").String,
Required: true,
PlanModifiers: []planmodifier.Int64{
int64planmodifier.RequiresReplace(),
},
},
"ack": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP ACK flag.").String,
Optional: true,
},
"action": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Action.").AddStringEnumDescription("invalid", "permit", "deny").AddDefaultValueDescription("invalid").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("invalid"),
Validators: []validator.String{
stringvalidator.OneOf("invalid", "permit", "deny"),
},
},
"dscp": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("Match DSCP.").AddIntegerRangeDescription(0, 63).String,
Optional: true,
Validators: []validator.Int64{
int64validator.Between(0, 63),
},
},
"destination_address_group": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Destination address group.").String,
Optional: true,
},
"destination_port_1": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("First destination port number or name.").AddStringEnumDescription("echo", "discard", "daytime", "chargen", "ftp-data", "ftp", "telnet", "smtp", "time", "nameserver", "whois", "tacacs", "domain", "bootps", "bootpc", "tftp", "gopher", "finger", "www", "hostname", "pop2", "pop3", "sunrpc", "ident", "nntp", "ntp", "netbios-ns", "netbios-dgm", "netbios-ss", "snmp", "snmptrap", "xdmcp", "bgp", "irc", "dnsix", "mobile-ip", "pim-auto-rp", "isakmp", "biff", "exec", "who", "login", "syslog", "cmd", "lpd", "talk", "rip", "uucp", "klogin", "kshell", "drip", "non500-isakmp").String,
Optional: true,
},
"destination_port_2": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Second destination port number or name.").AddStringEnumDescription("echo", "discard", "daytime", "chargen", "ftp-data", "ftp", "telnet", "smtp", "time", "nameserver", "whois", "tacacs", "domain", "bootps", "bootpc", "tftp", "gopher", "finger", "www", "hostname", "pop2", "pop3", "sunrpc", "ident", "nntp", "ntp", "netbios-ns", "netbios-dgm", "netbios-ss", "snmp", "snmptrap", "xdmcp", "bgp", "irc", "dnsix", "mobile-ip", "pim-auto-rp", "isakmp", "biff", "exec", "who", "login", "syslog", "cmd", "lpd", "talk", "rip", "uucp", "klogin", "kshell", "drip", "non500-isakmp").String,
Optional: true,
},
"destination_port_group": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Destination port group.").String,
Optional: true,
},
"destination_port_mask": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Destination port mask number or name.").AddStringEnumDescription("echo", "discard", "daytime", "chargen", "ftp-data", "ftp", "telnet", "smtp", "time", "nameserver", "whois", "tacacs", "domain", "bootps", "bootpc", "tftp", "gopher", "finger", "www", "hostname", "pop2", "pop3", "sunrpc", "ident", "nntp", "ntp", "netbios-ns", "netbios-dgm", "netbios-ss", "snmp", "snmptrap", "xdmcp", "bgp", "irc", "dnsix", "mobile-ip", "pim-auto-rp", "isakmp", "biff", "exec", "who", "login", "syslog", "cmd", "lpd", "talk", "rip", "uucp", "klogin", "kshell", "drip", "non500-isakmp").String,
Optional: true,
},
"destination_port_operator": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Destination port operator.").AddStringEnumDescription("none", "lt", "gt", "eq", "neq", "range").AddDefaultValueDescription("none").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("none"),
Validators: []validator.String{
stringvalidator.OneOf("none", "lt", "gt", "eq", "neq", "range"),
},
},
"destination_prefix": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Destination prefix.").String,
Optional: true,
},
"destination_prefix_length": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Destination prefix length.").String,
Optional: true,
},
"destination_prefix_mask": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Destination prefix mask.").String,
Optional: true,
},
"est": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP EST flag.").String,
Optional: true,
},
"fin": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP FIN flag.").String,
Optional: true,
},
"fragment": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match non-initial fragment.").String,
Optional: true,
},
"http_option_type": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("HTTP option method.").AddStringEnumDescription("invalid", "get", "put", "head", "post", "delete", "trace", "connect").AddDefaultValueDescription("invalid").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("invalid"),
Validators: []validator.String{
stringvalidator.OneOf("invalid", "get", "put", "head", "post", "delete", "trace", "connect"),
},
},
"icmp_code": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("ICMP code.").AddIntegerRangeDescription(0, 256).AddDefaultValueDescription("256").String,
Optional: true,
Computed: true,
Default: int64default.StaticInt64(256),
Validators: []validator.Int64{
int64validator.Between(0, 256),
},
},
"icmp_type": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("ICMP type.").AddIntegerRangeDescription(0, 256).AddDefaultValueDescription("256").String,
Optional: true,
Computed: true,
Default: int64default.StaticInt64(256),
Validators: []validator.Int64{
int64validator.Between(0, 256),
},
},
"logging": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Log matches against ACL entry.").AddDefaultValueDescription("false").String,
Optional: true,
Computed: true,
Default: booldefault.StaticBool(false),
},
"packet_length_1": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("First packet length. Either `invalid` or a number between 19 and 9210.").AddDefaultValueDescription("invalid").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("invalid"),
},
"packet_length_2": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Second packet length. Either `invalid` or a number between 19 and 9210.").AddDefaultValueDescription("invalid").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("invalid"),
},
"packet_length_operator": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Packet length operator.").AddStringEnumDescription("none", "lt", "gt", "eq", "neq", "range").AddDefaultValueDescription("none").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("none"),
Validators: []validator.String{
stringvalidator.OneOf("none", "lt", "gt", "eq", "neq", "range"),
},
},
"precedence": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Precedence. Either `unspecified` or a number between 0 and 7.").AddDefaultValueDescription("unspecified").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("unspecified"),
},
"protocol": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Protocol name or number.").AddStringEnumDescription("ip", "icmp", "igmp", "tcp", "udp", "gre", "esp", "ahp", "eigrp", "ospf", "nos", "pim", "pcp", "udf").String,
Optional: true,
},
"protocol_mask": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Protocol mask name or number.").AddStringEnumDescription("ip", "icmp", "igmp", "tcp", "udp", "gre", "esp", "ahp", "eigrp", "ospf", "nos", "pim", "pcp", "udf").String,
Optional: true,
},
"psh": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP PSH flag.").String,
Optional: true,
},
"redirect": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Redirect action.").String,
Optional: true,
},
"remark": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("ACL comment.").String,
Optional: true,
},
"rev": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP REV flag.").String,
Optional: true,
},
"rst": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP RST flag.").String,
Optional: true,
},
"source_address_group": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Source address group.").String,
Optional: true,
},
"source_port_1": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("First source port name or number.").AddStringEnumDescription("echo", "discard", "daytime", "chargen", "ftp-data", "ftp", "telnet", "smtp", "time", "nameserver", "whois", "tacacs", "domain", "bootps", "bootpc", "tftp", "gopher", "finger", "www", "hostname", "pop2", "pop3", "sunrpc", "ident", "nntp", "ntp", "netbios-ns", "netbios-dgm", "netbios-ss", "snmp", "snmptrap", "xdmcp", "bgp", "irc", "dnsix", "mobile-ip", "pim-auto-rp", "isakmp", "biff", "exec", "who", "login", "syslog", "cmd", "lpd", "talk", "rip", "uucp", "klogin", "kshell", "drip", "non500-isakmp").String,
Optional: true,
},
"source_port_2": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Second source port name or number.").AddStringEnumDescription("echo", "discard", "daytime", "chargen", "ftp-data", "ftp", "telnet", "smtp", "time", "nameserver", "whois", "tacacs", "domain", "bootps", "bootpc", "tftp", "gopher", "finger", "www", "hostname", "pop2", "pop3", "sunrpc", "ident", "nntp", "ntp", "netbios-ns", "netbios-dgm", "netbios-ss", "snmp", "snmptrap", "xdmcp", "bgp", "irc", "dnsix", "mobile-ip", "pim-auto-rp", "isakmp", "biff", "exec", "who", "login", "syslog", "cmd", "lpd", "talk", "rip", "uucp", "klogin", "kshell", "drip", "non500-isakmp").String,
Optional: true,
},
"source_port_group": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Source port group.").String,
Optional: true,
},
"source_port_mask": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Source port mask name or number.").AddStringEnumDescription("echo", "discard", "daytime", "chargen", "ftp-data", "ftp", "telnet", "smtp", "time", "nameserver", "whois", "tacacs", "domain", "bootps", "bootpc", "tftp", "gopher", "finger", "www", "hostname", "pop2", "pop3", "sunrpc", "ident", "nntp", "ntp", "netbios-ns", "netbios-dgm", "netbios-ss", "snmp", "snmptrap", "xdmcp", "bgp", "irc", "dnsix", "mobile-ip", "pim-auto-rp", "isakmp", "biff", "exec", "who", "login", "syslog", "cmd", "lpd", "talk", "rip", "uucp", "klogin", "kshell", "drip", "non500-isakmp").String,
Optional: true,
},
"source_port_operator": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Source port operator.").AddStringEnumDescription("none", "lt", "gt", "eq", "neq", "range").AddDefaultValueDescription("none").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("none"),
Validators: []validator.String{
stringvalidator.OneOf("none", "lt", "gt", "eq", "neq", "range"),
},
},
"source_prefix": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Source prefix.").String,
Optional: true,
},
"source_prefix_length": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Source prefix length.").String,
Optional: true,
},
"source_prefix_mask": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Source prefix mask.").String,
Optional: true,
},
"syn": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP SYN flag.").String,
Optional: true,
},
"time_range": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Time range name.").String,
Optional: true,
},
"ttl": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("TTL.").AddIntegerRangeDescription(0, 255).AddDefaultValueDescription("0").String,
Optional: true,
Computed: true,
Default: int64default.StaticInt64(0),
Validators: []validator.Int64{
int64validator.Between(0, 255),
},
},
"urg": schema.BoolAttribute{
MarkdownDescription: helpers.NewAttributeDescription("Match TCP URG flag.").String,
Optional: true,
},
"vlan": schema.Int64Attribute{
MarkdownDescription: helpers.NewAttributeDescription("VLAN ID.").AddIntegerRangeDescription(0, 4095).AddDefaultValueDescription("4095").String,
Optional: true,
Computed: true,
Default: int64default.StaticInt64(4095),
Validators: []validator.Int64{
int64validator.Between(0, 4095),
},
},
"vni": schema.StringAttribute{
MarkdownDescription: helpers.NewAttributeDescription("NVE VNI ID. Either `invalid` or a number between 0 and 16777216.").AddDefaultValueDescription("invalid").String,
Optional: true,
Computed: true,
Default: stringdefault.StaticString("invalid"),
},
},
}
}
func (r *IPv4AccessListEntryResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
// Prevent panic if the provider has not been configured.
if req.ProviderData == nil {
return
}
r.clients = req.ProviderData.(map[string]*nxos.Client)
}
func (r *IPv4AccessListEntryResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
var plan IPv4AccessListEntry
// Read plan
diags := req.Plan.Get(ctx, &plan)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Create", plan.getDn()))
// Post object
body := plan.toBody()
_, err := r.clients[plan.Device.ValueString()].Post(plan.getDn(), body.Str)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to post object, got error: %s", err))
return
}
plan.Dn = types.StringValue(plan.getDn())
tflog.Debug(ctx, fmt.Sprintf("%s: Create finished successfully", plan.getDn()))
diags = resp.State.Set(ctx, &plan)
resp.Diagnostics.Append(diags...)
}
func (r *IPv4AccessListEntryResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
var state IPv4AccessListEntry
// Read state
diags := req.State.Get(ctx, &state)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Read", state.Dn.ValueString()))
queries := []func(*nxos.Req){nxos.Query("rsp-prop-include", "config-only")}
res, err := r.clients[state.Device.ValueString()].GetDn(state.Dn.ValueString(), queries...)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to retrieve object, got error: %s", err))
return
}
state.fromBody(res, false)
tflog.Debug(ctx, fmt.Sprintf("%s: Read finished successfully", state.Dn.ValueString()))
diags = resp.State.Set(ctx, &state)
resp.Diagnostics.Append(diags...)
}
func (r *IPv4AccessListEntryResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
var plan IPv4AccessListEntry
// Read plan
diags := req.Plan.Get(ctx, &plan)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Update", plan.getDn()))
body := plan.toBody()
_, err := r.clients[plan.Device.ValueString()].Post(plan.getDn(), body.Str)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to update object, got error: %s", err))
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Update finished successfully", plan.getDn()))
diags = resp.State.Set(ctx, &plan)
resp.Diagnostics.Append(diags...)
}
func (r *IPv4AccessListEntryResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
var state IPv4AccessListEntry
// Read state
diags := req.State.Get(ctx, &state)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Delete", state.Dn.ValueString()))
res, err := r.clients[state.Device.ValueString()].DeleteDn(state.Dn.ValueString())
if err != nil {
errCode := res.Get("imdata.0.error.attributes.code").Str
// Ignore errors of type "Cannot delete object"
if errCode != "1" && errCode != "107" {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to update object, got error: %s", err))
return
}
}
tflog.Debug(ctx, fmt.Sprintf("%s: Delete finished successfully", state.Dn.ValueString()))
resp.State.RemoveResource(ctx)
}
func (r *IPv4AccessListEntryResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
}