-
Notifications
You must be signed in to change notification settings - Fork 89
/
aci.py
1767 lines (1553 loc) · 76.8 KB
/
aci.py
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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# This code is part of Ansible, but is an independent component
# This particular file snippet, and this file snippet only, is BSD licensed.
# Modules you write using this snippet, which is embedded dynamically by Ansible
# still belong to the author of the module, and may assign their own license
# to the complete work.
# Copyright: (c) 2017, Dag Wieers <dag@wieers.com>
# Copyright: (c) 2017, Jacob McGill (@jmcgill298)
# Copyright: (c) 2017, Swetha Chunduri (@schunduri)
# Copyright: (c) 2019, Rob Huelga (@RobW3LGA)
# Copyright: (c) 2020, Lionel Hercot (@lhercot) <lhercot@cisco.com>
# Copyright: (c) 2020, Anvitha Jain (@anvitha-jain) <anvjain@cisco.com>
# Copyright: (c) 2023, Gaspard Micol (@gmicol) <gmicol@cisco.com>
# Copyright: (c) 2023, Shreyas Srish (@shrsr) <ssrish@cisco.com>
# Copyright: (c) 2023, Tim Cragg (@timcragg) <tcragg@cisco.com>
# Copyright: (c) 2024, Samita Bhattacharjee (@samiib) <samitab@cisco.com>
# All rights reserved.
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from __future__ import absolute_import, division, print_function
__metaclass__ = type
import base64
import json
import os
from copy import deepcopy
from ansible.module_utils.urls import fetch_url
from ansible.module_utils._text import to_bytes, to_native
from ansible.module_utils.basic import env_fallback
from ansible.module_utils.connection import Connection
# Optional, only used for APIC signature-based authentication
try:
from OpenSSL.crypto import FILETYPE_PEM, load_privatekey, sign
HAS_OPENSSL = True
except ImportError:
HAS_OPENSSL = False
# Signature-based authentication using cryptography
try:
from cryptography.hazmat.primitives import serialization, hashes
from cryptography.hazmat.primitives.asymmetric import padding
from cryptography.hazmat.backends import default_backend
HAS_CRYPTOGRAPHY = True
except ImportError:
HAS_CRYPTOGRAPHY = False
# Optional, only used for XML payload
try:
import lxml.etree
HAS_LXML_ETREE = True
except ImportError:
HAS_LXML_ETREE = False
# Optional, only used for XML payload
try:
from xmljson import cobra
HAS_XMLJSON_COBRA = True
except ImportError:
HAS_XMLJSON_COBRA = False
try:
from ansible.module_utils.six.moves.urllib.parse import urlparse
HAS_URLPARSE = True
except Exception:
HAS_URLPARSE = False
def aci_argument_spec():
return dict(
host=dict(
type="str",
aliases=["hostname"],
fallback=(env_fallback, ["ACI_HOST"]),
),
port=dict(type="int", required=False, fallback=(env_fallback, ["ACI_PORT"])),
username=dict(
type="str",
aliases=["user"],
fallback=(env_fallback, ["ACI_USERNAME", "ANSIBLE_NET_USERNAME"]),
),
password=dict(
type="str",
no_log=True,
fallback=(env_fallback, ["ACI_PASSWORD", "ANSIBLE_NET_PASSWORD"]),
),
# Beware, this is not the same as client_key !
private_key=dict(
type="str",
aliases=["cert_key"],
no_log=True,
fallback=(env_fallback, ["ACI_PRIVATE_KEY", "ANSIBLE_NET_SSH_KEYFILE"]),
),
# Beware, this is not the same as client_cert !
certificate_name=dict(
type="str",
aliases=["cert_name"],
fallback=(env_fallback, ["ACI_CERTIFICATE_NAME"]),
),
output_level=dict(
type="str",
default="normal",
choices=["debug", "info", "normal"],
fallback=(env_fallback, ["ACI_OUTPUT_LEVEL"]),
),
timeout=dict(type="int", fallback=(env_fallback, ["ACI_TIMEOUT"])),
use_proxy=dict(type="bool", fallback=(env_fallback, ["ACI_USE_PROXY"])),
use_ssl=dict(type="bool", fallback=(env_fallback, ["ACI_USE_SSL"])),
validate_certs=dict(type="bool", fallback=(env_fallback, ["ACI_VALIDATE_CERTS"])),
output_path=dict(type="str", fallback=(env_fallback, ["ACI_OUTPUT_PATH"])),
suppress_verification=dict(
type="bool",
aliases=["no_verification", "no_verify", "suppress_verify", "ignore_verify", "ignore_verification"],
fallback=(env_fallback, ["ACI_SUPPRESS_VERIFICATION"]),
),
suppress_previous=dict(type="bool", aliases=["no_previous", "ignore_previous"], fallback=(env_fallback, ["ACI_SUPPRESS_PREVIOUS"])),
)
def aci_annotation_spec():
return dict(
annotation=dict(
type="str",
default="orchestrator:ansible",
fallback=(env_fallback, ["ACI_ANNOTATION"]),
),
)
def aci_owner_spec():
return dict(
owner_key=dict(type="str", no_log=False, fallback=(env_fallback, ["ACI_OWNER_KEY"])),
owner_tag=dict(type="str", fallback=(env_fallback, ["ACI_OWNER_TAG"])),
)
def enhanced_lag_spec():
return dict(
name=dict(type="str", required=True),
lacp_mode=dict(type="str", choices=["active", "passive"]),
load_balancing_mode=dict(
type="str",
choices=[
"dst-ip",
"dst-ip-l4port",
"dst-ip-vlan",
"dst-ip-l4port-vlan",
"dst-mac",
"dst-l4port",
"src-ip",
"src-ip-l4port",
"src-ip-vlan",
"src-ip-l4port-vlan",
"src-mac",
"src-l4port",
"src-dst-ip",
"src-dst-ip-l4port",
"src-dst-ip-vlan",
"src-dst-ip-l4port-vlan",
"src-dst-mac",
"src-dst-l4port",
"src-port-id",
"vlan",
],
),
number_uplinks=dict(type="int"),
)
def netflow_spec():
return dict(
name=dict(type="str", required=True),
active_flow_timeout=dict(type="int"),
idle_flow_timeout=dict(type="int"),
sampling_rate=dict(type="int"),
)
def expression_spec():
return dict(
key=dict(type="str", required=True, no_log=False),
operator=dict(
type="str",
choices=[
"not_in",
"in",
"equals",
"not_equals",
"has_key",
"does_not_have_key",
],
required=True,
),
value=dict(type="str"),
)
def aci_contract_qos_spec():
return dict(type="str", choices=["level1", "level2", "level3", "unspecified"])
def aci_contract_dscp_spec(direction=None):
return dict(
type="str",
aliases=["target" if not direction else "target_{0}".format(direction)],
choices=[
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"CS0",
"CS1",
"CS2",
"CS3",
"CS4",
"CS5",
"CS6",
"CS7",
"EF",
"VA",
"unspecified",
],
)
def route_control_profile_spec():
return dict(
profile=dict(type="str", required=True),
l3out=dict(type="str"),
direction=dict(type="str", required=True),
tenant=dict(type="str", required=True),
)
def destination_epg_spec():
return dict(
tenant=dict(type="str", required=True, aliases=["tenant_name"]),
ap=dict(type="str", required=True, aliases=["ap_name", "app_profile", "app_profile_name"]),
epg=dict(type="str", required=True, aliases=["epg_name"]),
source_ip=dict(type="str", required=True),
destination_ip=dict(type="str", required=True),
span_version=dict(type="str", choices=["version_1", "version_2"]),
version_enforced=dict(type="bool"),
flow_id=dict(type="int"),
ttl=dict(type="int"),
mtu=dict(type="int"),
dscp=dict(
type="str",
choices=[
"CS0",
"CS1",
"CS2",
"CS3",
"CS4",
"CS5",
"CS6",
"CS7",
"EF",
"VA",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"unspecified",
],
),
)
def ospf_spec():
return dict(
area_cost=dict(type="int"),
area_ctrl=dict(type="list", elements="str", choices=["redistribute", "summary", "suppress-fa", "unspecified"]),
area_id=dict(type="str"),
area_type=dict(type="str", choices=["nssa", "regular", "stub"]),
description=dict(type="str", aliases=["descr"]),
multipod_internal=dict(type="str", choices=["no", "yes"]),
name_alias=dict(type="str"),
)
def integrate_url(httpapi_url, local_path):
parse_url = urlparse(httpapi_url)
return {"protocol": parse_url.scheme, "host": parse_url.netloc, "path": local_path}
def action_rule_set_comm_spec():
return dict(
community=dict(type="str"),
criteria=dict(type="str", choices=["append", "none", "replace"]),
)
def action_rule_set_dampening_spec():
return dict(
half_life=dict(type="int"),
max_suppress_time=dict(type="int"),
reuse=dict(type="int"),
suppress=dict(type="int"),
)
def associated_netflow_exporter_epg_spec():
return dict(
tenant=dict(type="str"),
ap=dict(type="str"),
epg=dict(type="str"),
)
def associated_netflow_exporter_extepg_spec():
return dict(
tenant=dict(type="str"),
l3out=dict(type="str"),
extepg=dict(type="str"),
)
def associated_netflow_exporter_vrf_spec():
return dict(
tenant=dict(type="str"),
vrf=dict(type="str"),
)
def pim_interface_profile_spec():
return dict(
tenant=dict(type="str", aliases=["tenant_name"]),
pim=dict(type="str", aliases=["pim_interface_policy", "name"]),
)
def igmp_interface_profile_spec():
return dict(tenant=dict(type="str", aliases=["tenant_name"]), igmp=dict(type="str", aliases=["igmp_interface_policy", "name"]))
def storm_control_policy_rate_spec():
return dict(
rate=dict(type="str"),
burst_rate=dict(type="str"),
rate_type=dict(type="str", choices=["percentage", "pps"], required=True),
)
class ACIModule(object):
def __init__(self, module):
self.module = module
self.params = module.params
self.result = dict(changed=False)
self.headers = dict()
self.child_classes = set()
self.connection = None
# error output
self.error = dict(code=None, text=None)
# normal output
self.existing = None
# info output
self.config = dict()
self.original = None
self.proposed = dict()
self.stdout = None
# debug output
self.filter_string = ""
self.obj_filter = None
self.method = None
self.path = None
self.parent_path = None
self.response = None
self.status = None
self.url = None
self.httpapi_logs = list()
# aci_rest output
self.imdata = None
self.totalCount = None
# get no verify flag
self.suppress_verification = self.params.get("suppress_verification")
# get suppress previous flag
self.suppress_previous = self.params.get("suppress_previous")
# Ensure protocol is set
self.define_protocol()
# Set Connection plugin
self.set_connection()
if self.module._debug:
self.module.warn("Enable debug output because ANSIBLE_DEBUG was set.")
self.params["output_level"] = "debug"
if self.params.get("port") is not None:
self.base_url = "{protocol}://{host}:{port}".format_map(self.params)
else:
self.base_url = "{protocol}://{host}".format_map(self.params)
if self.params.get("private_key"):
# Perform signature-based authentication, no need to log on separately
if not HAS_CRYPTOGRAPHY and not HAS_OPENSSL:
self.module.fail_json(msg="Cannot use signature-based authentication because cryptography (preferred) or pyopenssl are not available")
elif self.params.get("password") is not None:
self.module.warn("When doing ACI signatured-based authentication, providing parameter 'password' is not required")
elif self.connection is None:
if self.params.get("password"):
# Perform password-based authentication, log on using password
self.login()
else:
self.module.fail_json(msg="Either parameter 'password' or 'private_key' is required for authentication")
def boolean(self, value, true="yes", false="no"):
"""Return an acceptable value back"""
# When we expect value is of type=bool
if value is None:
return None
elif value is True:
return true
elif value is False:
return false
# If all else fails, escalate back to user
self.module.fail_json(msg="Boolean value '%s' is an invalid ACI boolean value.")
def iso8601_format(self, dt):
"""Return an ACI-compatible ISO8601 formatted time: 2123-12-12T00:00:00.000+00:00"""
try:
return dt.isoformat(timespec="milliseconds")
except Exception:
tz = dt.strftime("%z")
return "%s.%03d%s:%s" % (
dt.strftime("%Y-%m-%dT%H:%M:%S"),
dt.microsecond / 1000,
tz[:3],
tz[3:],
)
def define_protocol(self):
"""Set protocol based on use_ssl parameter"""
# Set protocol for further use
self.params["protocol"] = "https" if self.params.get("use_ssl") or self.params.get("use_ssl") is None else "http"
def set_connection(self):
if self.connection is None and self.module._socket_path:
self.connection = Connection(self.module._socket_path)
def login(self):
"""Log in to APIC"""
# Perform login request
url = "{0}/api/aaaLogin.json".format(self.base_url)
payload = {
"aaaUser": {
"attributes": {
"name": "admin" if self.params.get("username") is None else self.params.get("username"),
"pwd": self.params.get("password"),
}
}
}
resp, auth = self.api_call("POST", url, data=json.dumps(payload), return_response=True)
# Handle APIC response
if auth.get("status") != 200:
self.response = auth.get("msg")
self.status = auth.get("status")
try:
# APIC error
self.response_json(auth["body"])
self.fail_json(msg="Authentication failed: {code} {text}".format_map(self.error))
except KeyError:
# Connection error
self.fail_json(msg="Connection failed for {url}. {msg}".format_map(auth))
# Retain cookie for later use
self.headers["Cookie"] = resp.headers.get("Set-Cookie")
def cert_auth(self, path=None, payload="", method=None):
"""Perform APIC signature-based authentication, not the expected SSL client certificate authentication."""
if method is None:
method = self.params.get("method").upper()
# NOTE: ACI documentation incorrectly uses complete URL
if path is None:
path = self.path
path = "/" + path.lstrip("/")
if payload is None:
payload = ""
# Check if we got a private key. This allows the use of vaulting the private key.
try:
if HAS_CRYPTOGRAPHY:
key = self.params.get("private_key").encode()
sig_key = serialization.load_pem_private_key(
key,
password=None,
backend=default_backend(),
)
else:
sig_key = load_privatekey(FILETYPE_PEM, self.params.get("private_key"))
except Exception:
if os.path.exists(self.params.get("private_key")):
try:
permission = "r"
if HAS_CRYPTOGRAPHY:
permission = "rb"
with open(self.params.get("private_key"), permission) as fh:
private_key_content = fh.read()
except Exception:
self.module.fail_json(msg="Cannot open private key file '{private_key}'.".format_map(self.params))
try:
if HAS_CRYPTOGRAPHY:
sig_key = serialization.load_pem_private_key(
private_key_content,
password=None,
backend=default_backend(),
)
else:
sig_key = load_privatekey(FILETYPE_PEM, private_key_content)
except Exception:
self.module.fail_json(msg="Cannot load private key file '{private_key}'.".format_map(self.params))
if self.params.get("certificate_name") is None:
self.params["certificate_name"] = os.path.basename(os.path.splitext(self.params.get("private_key"))[0])
else:
self.module.fail_json(
msg="Provided private key {private_key} does not appear to be a private key or provided file does not exist.".format_map(self.params)
)
if self.params.get("certificate_name") is None:
self.params["certificate_name"] = "admin" if self.params.get("username") is None else self.params.get("username")
# NOTE: ACI documentation incorrectly adds a space between method and path
sig_request = method + path + payload
if HAS_CRYPTOGRAPHY:
sig_signature = sig_key.sign(sig_request.encode(), padding.PKCS1v15(), hashes.SHA256())
else:
sig_signature = sign(sig_key, sig_request, "sha256")
sig_dn = "uni/userext/user-{username}/usercert-{certificate_name}".format_map(self.params)
self.headers["Cookie"] = (
"APIC-Certificate-Algorithm=v1.0; "
+ "APIC-Certificate-DN={0}; ".format(sig_dn)
+ "APIC-Certificate-Fingerprint=fingerprint; "
+ "APIC-Request-Signature={0}".format(to_native(base64.b64encode(sig_signature)))
)
def response_json(self, rawoutput):
"""Handle APIC JSON response output"""
try:
jsondata = json.loads(rawoutput)
except Exception as e:
# Expose RAW output for troubleshooting
self.error = dict(code=-1, text="Unable to parse output as JSON, see 'raw' output. {0}".format(e))
self.result["raw"] = rawoutput
return
# Extract JSON API output
self.imdata = jsondata.get("imdata")
if self.imdata is None:
self.imdata = dict()
self.totalCount = int(jsondata.get("totalCount"))
# Handle possible APIC error information
self.response_error()
def response_xml(self, rawoutput):
"""Handle APIC XML response output"""
# NOTE: The XML-to-JSON conversion is using the "Cobra" convention
try:
xml = lxml.etree.fromstring(to_bytes(rawoutput))
xmldata = cobra.data(xml)
except Exception as e:
# Expose RAW output for troubleshooting
self.error = dict(code=-1, text="Unable to parse output as XML, see 'raw' output. {0}".format(e))
self.result["raw"] = rawoutput
return
# Reformat as ACI does for JSON API output
self.imdata = xmldata.get("imdata", {}).get("children")
if self.imdata is None:
self.imdata = dict()
self.totalCount = int(xmldata.get("imdata", {}).get("attributes", {}).get("totalCount", -1))
# Handle possible APIC error information
self.response_error()
def response_error(self):
"""Set error information when found"""
# Handle possible APIC error information
if self.totalCount != "0":
try:
self.error = self.imdata[0].get("error").get("attributes")
except (AttributeError, IndexError, KeyError):
pass
# TODO: This could be designed to update existing keys
def update_qs(self, params):
"""Append key-value pairs to self.filter_string"""
accepted_params = dict((k, v) for (k, v) in params.items() if v is not None)
if accepted_params:
if self.filter_string:
self.filter_string += "&"
else:
self.filter_string = "?"
self.filter_string += "&".join(["%s=%s" % (k, v) for (k, v) in accepted_params.items()])
# TODO: This could be designed to accept multiple obj_classes and keys
def build_filter(self, obj_class, params):
"""Build an APIC filter based on obj_class and key-value pairs"""
accepted_params = dict((k, v) for (k, v) in params.items() if v is not None)
if len(accepted_params) == 1:
return ",".join('eq({0}.{1},"{2}")'.format(obj_class, k, v) for (k, v) in accepted_params.items())
elif len(accepted_params) > 1:
return "and(" + ",".join(['eq({0}.{1},"{2}")'.format(obj_class, k, v) for (k, v) in accepted_params.items()]) + ")"
def _deep_url_path_builder(self, obj):
target_class = obj.get("target_class")
target_filter = obj.get("target_filter")
subtree_class = obj.get("subtree_class")
subtree_filter = obj.get("subtree_filter")
object_rn = obj.get("object_rn")
mo = obj.get("module_object")
add_subtree_filter = obj.get("add_subtree_filter")
add_target_filter = obj.get("add_target_filter")
if self.module.params.get("state") in ("absent", "present") and mo is not None:
self.path = "api/mo/uni/{0}.json".format(object_rn)
self.update_qs({"rsp-prop-include": "config-only"})
else:
# State is 'query'
if object_rn is not None:
# Query for a specific object in the module's class
self.path = "api/mo/uni/{0}.json".format(object_rn)
else:
self.path = "api/class/{0}.json".format(target_class)
if add_target_filter:
self.update_qs({"query-target-filter": self.build_filter(target_class, target_filter)})
if add_subtree_filter:
self.update_qs({"rsp-subtree-filter": self.build_filter(subtree_class, subtree_filter)})
if self.params.get("port") is not None:
self.url = "{protocol}://{host}:{port}/{path}".format(path=self.path, **self.module.params)
else:
self.url = "{protocol}://{host}/{path}".format(path=self.path, **self.module.params)
if self.child_classes:
self.update_qs(
{
"rsp-subtree": "full",
"rsp-subtree-class": ",".join(sorted(self.child_classes)),
}
)
def _deep_url_parent_object(self, parent_objects, parent_class):
for parent_object in parent_objects:
if parent_object.get("aci_class") is parent_class:
return parent_object
return None
def construct_deep_url(self, target_object, parent_objects=None, child_classes=None):
"""
This method is used to retrieve the appropriate URL path and filter_string to make the request to the APIC.
:param target_object: The target class dictionary containing parent_class, aci_class, aci_rn, target_filter, and module_object keys.
:param parent_objects: The parent class list of dictionaries containing parent_class, aci_class, aci_rn, target_filter, and module_object keys.
:param child_classes: The list of child classes that the module supports along with the object.
:type target_object: dict
:type parent_objects: list[dict]
:type child_classes: list[string]
:return: The path and filter_string needed to build the full URL.
"""
self.filter_string = ""
rn_builder = None
subtree_classes = None
add_subtree_filter = False
add_target_filter = False
has_target_query = False
has_target_query_compare = False
has_target_query_difference = False
has_target_query_called = False
if child_classes is None:
self.child_classes = set()
else:
self.child_classes = set(child_classes)
target_parent_class = target_object.get("parent_class")
target_class = target_object.get("aci_class")
target_rn = target_object.get("aci_rn")
target_filter = target_object.get("target_filter")
target_module_object = target_object.get("module_object")
url_path_object = dict(
target_class=target_class,
target_filter=target_filter,
subtree_class=target_class,
subtree_filter=target_filter,
module_object=target_module_object,
)
if target_module_object is not None:
rn_builder = target_rn
else:
has_target_query = True
has_target_query_compare = True
if parent_objects is not None:
current_parent_class = target_parent_class
has_parent_query_compare = False
has_parent_query_difference = False
is_first_parent = True
is_single_parent = None
search_classes = set()
while current_parent_class != "uni":
parent_object = self._deep_url_parent_object(parent_objects=parent_objects, parent_class=current_parent_class)
if parent_object is not None:
parent_parent_class = parent_object.get("parent_class")
parent_class = parent_object.get("aci_class")
parent_rn = parent_object.get("aci_rn")
parent_filter = parent_object.get("target_filter")
parent_module_object = parent_object.get("module_object")
if is_first_parent:
is_single_parent = True
else:
is_single_parent = False
is_first_parent = False
if parent_parent_class != "uni":
search_classes.add(parent_class)
if parent_module_object is not None:
if rn_builder is not None:
rn_builder = "{0}/{1}".format(parent_rn, rn_builder)
else:
rn_builder = parent_rn
url_path_object["target_class"] = parent_class
url_path_object["target_filter"] = parent_filter
has_target_query = False
else:
rn_builder = None
subtree_classes = search_classes
has_target_query = True
if is_single_parent:
has_parent_query_compare = True
current_parent_class = parent_parent_class
else:
raise ValueError("Reference error for parent_class '{0}'. Each parent_class must reference a valid object".format(current_parent_class))
if not has_target_query_difference and not has_target_query_called:
if has_target_query is not has_target_query_compare:
has_target_query_difference = True
else:
if not has_parent_query_difference and has_target_query is not has_parent_query_compare:
has_parent_query_difference = True
has_target_query_called = True
if not has_parent_query_difference and has_parent_query_compare and target_module_object is not None:
add_target_filter = True
elif has_parent_query_difference and target_module_object is not None:
add_subtree_filter = True
self.child_classes.add(target_class)
if has_target_query:
add_target_filter = True
elif has_parent_query_difference and not has_target_query and target_module_object is None:
self.child_classes.add(target_class)
self.child_classes.update(subtree_classes)
elif not has_parent_query_difference and not has_target_query and target_module_object is None:
self.child_classes.add(target_class)
elif not has_target_query and is_single_parent and target_module_object is None:
self.child_classes.add(target_class)
url_path_object["object_rn"] = rn_builder
url_path_object["add_subtree_filter"] = add_subtree_filter
url_path_object["add_target_filter"] = add_target_filter
self._deep_url_path_builder(url_path_object)
def construct_url(
self,
root_class,
subclass_1=None,
subclass_2=None,
subclass_3=None,
subclass_4=None,
subclass_5=None,
subclass_6=None,
child_classes=None,
config_only=True,
rsp_subtree="full",
):
"""
This method is used to retrieve the appropriate URL path and filter_string to make the request to the APIC.
:param root_class: The top-level class dictionary containing aci_class, aci_rn, target_filter, and module_object keys.
:param sublass_1: The second-level class dictionary containing aci_class, aci_rn, target_filter, and module_object keys.
:param sublass_2: The third-level class dictionary containing aci_class, aci_rn, target_filter, and module_object keys.
:param sublass_3: The fourth-level class dictionary containing aci_class, aci_rn, target_filter, and module_object keys.
:param child_classes: The list of child classes that the module supports along with the object.
:type root_class: dict
:type subclass_1: dict
:type subclass_2: dict
:type subclass_3: dict
:type subclass_4: dict
:type subclass_5: dict
:type subclass_6: dict
:type child_classes: list
:return: The path and filter_string needed to build the full URL.
"""
self.filter_string = ""
if child_classes is None:
self.child_classes = set()
else:
self.child_classes = set(child_classes)
if subclass_6 is not None:
self._construct_url_7(root_class, subclass_1, subclass_2, subclass_3, subclass_4, subclass_5, subclass_6, config_only)
elif subclass_5 is not None:
self._construct_url_6(root_class, subclass_1, subclass_2, subclass_3, subclass_4, subclass_5, config_only)
elif subclass_4 is not None:
self._construct_url_5(root_class, subclass_1, subclass_2, subclass_3, subclass_4, config_only)
elif subclass_3 is not None:
self._construct_url_4(root_class, subclass_1, subclass_2, subclass_3, config_only)
elif subclass_2 is not None:
self._construct_url_3(root_class, subclass_1, subclass_2, config_only)
elif subclass_1 is not None:
self._construct_url_2(root_class, subclass_1, config_only)
else:
self._construct_url_1(root_class, config_only)
if self.params.get("port") is not None:
self.url = "{protocol}://{host}:{port}/{path}".format(path=self.path, **self.module.params)
else:
self.url = "{protocol}://{host}/{path}".format(path=self.path, **self.module.params)
if self.child_classes:
# Append child_classes to filter_string if filter string is empty
self.update_qs(
{
"rsp-subtree": rsp_subtree,
"rsp-subtree-class": ",".join(sorted(self.child_classes)),
}
)
elif rsp_subtree == "children":
self.update_qs({"rsp-subtree": rsp_subtree})
def _construct_url_1(self, obj, config_only=True):
"""
This method is used by construct_url when the object is the top-level class.
"""
obj_class = obj.get("aci_class")
obj_rn = obj.get("aci_rn")
obj_filter = obj.get("target_filter")
mo = obj.get("module_object")
if self.module.params.get("state") in ("absent", "present"):
# State is absent or present
self.path = "api/mo/uni/{0}.json".format(obj_rn)
self.parent_path = "api/mo/uni.json"
if config_only:
self.update_qs({"rsp-prop-include": "config-only"})
self.obj_filter = obj_filter
elif mo is None:
# Query for all objects of the module's class (filter by properties)
self.path = "api/class/{0}.json".format(obj_class)
if obj_filter is not None:
self.update_qs({"query-target-filter": self.build_filter(obj_class, obj_filter)})
else:
# Query for a specific object in the module's class
self.path = "api/mo/uni/{0}.json".format(obj_rn)
def _construct_url_2(self, parent, obj, config_only=True):
"""
This method is used by construct_url when the object is the second-level class.
"""
parent_rn = parent.get("aci_rn")
parent_obj = parent.get("module_object")
obj_class = obj.get("aci_class")
obj_rn = obj.get("aci_rn")
obj_filter = obj.get("target_filter")
mo = obj.get("module_object")
if self.module.params.get("state") in ("absent", "present"):
# State is absent or present
self.path = "api/mo/uni/{0}/{1}.json".format(parent_rn, obj_rn)
self.parent_path = "api/mo/uni/{0}.json".format(parent_rn)
if config_only:
self.update_qs({"rsp-prop-include": "config-only"})
self.obj_filter = obj_filter
elif parent_obj is None and mo is None:
# Query for all objects of the module's class
self.path = "api/class/{0}.json".format(obj_class)
self.update_qs({"query-target-filter": self.build_filter(obj_class, obj_filter)})
elif parent_obj is None: # mo is known
# Query for all objects of the module's class that match the provided ID value
self.path = "api/class/{0}.json".format(obj_class)
self.update_qs({"query-target-filter": self.build_filter(obj_class, obj_filter)})
elif mo is None: # parent_obj is known
# Query for all object's of the module's class that belong to a specific parent object
self.child_classes.add(obj_class)
self.path = "api/mo/uni/{0}.json".format(parent_rn)
else:
# Query for specific object in the module's class
self.path = "api/mo/uni/{0}/{1}.json".format(parent_rn, obj_rn)
def _construct_url_3(self, root, parent, obj, config_only=True):
"""
This method is used by construct_url when the object is the third-level class.
"""
root_rn = root.get("aci_rn")
root_obj = root.get("module_object")
parent_class = parent.get("aci_class")
parent_rn = parent.get("aci_rn")
parent_filter = parent.get("target_filter")
parent_obj = parent.get("module_object")
obj_class = obj.get("aci_class")
obj_rn = obj.get("aci_rn")
obj_filter = obj.get("target_filter")
mo = obj.get("module_object")
if self.module.params.get("state") in ("absent", "present"):
# State is absent or present
self.path = "api/mo/uni/{0}/{1}/{2}.json".format(root_rn, parent_rn, obj_rn)
self.parent_path = "api/mo/uni/{0}/{1}.json".format(root_rn, parent_rn)
if config_only:
self.update_qs({"rsp-prop-include": "config-only"})
self.obj_filter = obj_filter
elif root_obj is None and parent_obj is None and mo is None:
# Query for all objects of the module's class
self.path = "api/class/{0}.json".format(obj_class)
self.update_qs({"query-target-filter": self.build_filter(obj_class, obj_filter)})
elif root_obj is None and parent_obj is None: # mo is known