catalystwan 0.41.2__py3-none-any.whl → 0.41.2.dev1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (504) hide show
  1. catalystwan/__init__.py +3 -2
  2. catalystwan/api/administration.py +13 -2
  3. catalystwan/api/api_container.py +4 -1
  4. catalystwan/api/builders/__init__.py +14 -0
  5. catalystwan/api/builders/feature_profiles/__init__.py +0 -0
  6. catalystwan/api/builders/feature_profiles/application_priority.py +58 -0
  7. catalystwan/api/builders/feature_profiles/builder_factory.py +59 -0
  8. catalystwan/api/builders/feature_profiles/cli.py +76 -0
  9. catalystwan/api/builders/feature_profiles/mixins.py +44 -0
  10. catalystwan/api/builders/feature_profiles/other.py +79 -0
  11. catalystwan/api/builders/feature_profiles/report.py +155 -0
  12. catalystwan/api/builders/feature_profiles/service.py +248 -0
  13. catalystwan/api/builders/feature_profiles/system.py +80 -0
  14. catalystwan/api/builders/feature_profiles/transport.py +256 -0
  15. catalystwan/api/builders/feature_profiles/uc_voice.py +287 -0
  16. catalystwan/api/config_group_api.py +41 -16
  17. catalystwan/api/configuration_groups/parcel.py +100 -30
  18. catalystwan/api/feature_profile_api.py +2021 -242
  19. catalystwan/api/policy_api.py +470 -116
  20. catalystwan/api/template_api.py +113 -44
  21. catalystwan/api/templates/README.md +61 -47
  22. catalystwan/api/templates/cli_template.py +17 -7
  23. catalystwan/api/templates/device_template/device_template.py +127 -32
  24. catalystwan/api/templates/feature_template.py +3 -3
  25. catalystwan/api/templates/models/aaa_model.py +387 -0
  26. catalystwan/api/templates/models/cisco_aaa_model.py +289 -42
  27. catalystwan/api/templates/models/cisco_banner_model.py +11 -2
  28. catalystwan/api/templates/models/cisco_bfd_model.py +31 -36
  29. catalystwan/api/templates/models/cisco_bgp_model.py +382 -131
  30. catalystwan/api/templates/models/cisco_logging_model.py +80 -43
  31. catalystwan/api/templates/models/cisco_ntp_model.py +34 -15
  32. catalystwan/api/templates/models/cisco_omp_model.py +70 -60
  33. catalystwan/api/templates/models/cisco_ospf.py +143 -74
  34. catalystwan/api/templates/models/cisco_ospfv3.py +217 -95
  35. catalystwan/api/templates/models/cisco_secure_internet_gateway.py +304 -142
  36. catalystwan/api/templates/models/cisco_snmp_model.py +66 -52
  37. catalystwan/api/templates/models/cisco_system.py +238 -129
  38. catalystwan/api/templates/models/cisco_vpn_interface_model.py +632 -275
  39. catalystwan/api/templates/models/cisco_vpn_model.py +433 -270
  40. catalystwan/api/templates/models/cli_template.py +3 -2
  41. catalystwan/api/templates/models/omp_vsmart_model.py +46 -10
  42. catalystwan/api/templates/models/security_vsmart_model.py +11 -8
  43. catalystwan/api/templates/models/supported.py +10 -4
  44. catalystwan/api/templates/models/system_vsmart_model.py +164 -27
  45. catalystwan/api/templates/models/vpn_vsmart_interface_model.py +198 -0
  46. catalystwan/api/templates/models/vpn_vsmart_model.py +124 -0
  47. catalystwan/apigw_auth.py +6 -2
  48. catalystwan/dataclasses.py +2 -53
  49. catalystwan/endpoints/__init__.py +41 -41
  50. catalystwan/endpoints/certificate_management_device.py +4 -0
  51. catalystwan/endpoints/cluster_management.py +27 -7
  52. catalystwan/endpoints/configuration/feature_profile/sdwan/application_priority.py +107 -0
  53. catalystwan/endpoints/configuration/feature_profile/sdwan/cli.py +60 -0
  54. catalystwan/endpoints/configuration/feature_profile/sdwan/dns_security.py +83 -0
  55. catalystwan/endpoints/configuration/feature_profile/sdwan/embedded_security.py +88 -0
  56. catalystwan/endpoints/configuration/feature_profile/sdwan/other.py +62 -0
  57. catalystwan/endpoints/configuration/feature_profile/sdwan/policy_object.py +35 -12
  58. catalystwan/endpoints/configuration/feature_profile/sdwan/service.py +154 -0
  59. catalystwan/endpoints/configuration/feature_profile/sdwan/sig_security.py +88 -0
  60. catalystwan/endpoints/configuration/feature_profile/sdwan/system.py +164 -11
  61. catalystwan/endpoints/configuration/feature_profile/sdwan/topology.py +93 -0
  62. catalystwan/endpoints/configuration/feature_profile/sdwan/transport.py +144 -26
  63. catalystwan/endpoints/configuration/feature_profile/sdwan/uc_voice.py +77 -0
  64. catalystwan/endpoints/configuration/network_hierarchy.py +32 -0
  65. catalystwan/endpoints/configuration/policy/abstractions.py +49 -0
  66. catalystwan/endpoints/configuration/policy/definition/access_control_list.py +6 -11
  67. catalystwan/endpoints/configuration/policy/definition/access_control_list_ipv6.py +6 -11
  68. catalystwan/endpoints/configuration/policy/definition/aip.py +52 -0
  69. catalystwan/endpoints/configuration/policy/definition/amp.py +52 -0
  70. catalystwan/endpoints/configuration/policy/definition/app_route.py +50 -0
  71. catalystwan/endpoints/configuration/policy/definition/cflowd.py +46 -0
  72. catalystwan/endpoints/configuration/policy/definition/control.py +6 -11
  73. catalystwan/endpoints/configuration/policy/definition/device_access.py +6 -11
  74. catalystwan/endpoints/configuration/policy/definition/device_access_ipv6.py +6 -11
  75. catalystwan/endpoints/configuration/policy/definition/dial_peer.py +57 -0
  76. catalystwan/endpoints/configuration/policy/definition/dns_security.py +50 -0
  77. catalystwan/endpoints/configuration/policy/definition/fxo_port.py +57 -0
  78. catalystwan/endpoints/configuration/policy/definition/fxs_did_port.py +57 -0
  79. catalystwan/endpoints/configuration/policy/definition/fxs_port.py +57 -0
  80. catalystwan/endpoints/configuration/policy/definition/hub_and_spoke.py +6 -11
  81. catalystwan/endpoints/configuration/policy/definition/intrusion_prevention.py +52 -0
  82. catalystwan/endpoints/configuration/policy/definition/mesh.py +2 -11
  83. catalystwan/endpoints/configuration/policy/definition/pri_isdn_port.py +57 -0
  84. catalystwan/endpoints/configuration/policy/definition/qos_map.py +2 -11
  85. catalystwan/endpoints/configuration/policy/definition/rewrite.py +6 -11
  86. catalystwan/endpoints/configuration/policy/definition/route_policy.py +50 -0
  87. catalystwan/endpoints/configuration/policy/definition/rule_set.py +2 -11
  88. catalystwan/endpoints/configuration/policy/definition/security_group.py +6 -11
  89. catalystwan/endpoints/configuration/policy/definition/srst_phone_profile.py +59 -0
  90. catalystwan/endpoints/configuration/policy/definition/ssl_decryption.py +50 -0
  91. catalystwan/endpoints/configuration/policy/definition/ssl_decryption_utd_profile.py +52 -0
  92. catalystwan/endpoints/configuration/policy/definition/traffic_data.py +6 -11
  93. catalystwan/endpoints/configuration/policy/definition/url_filtering.py +50 -0
  94. catalystwan/endpoints/configuration/policy/definition/vpn_membership.py +6 -11
  95. catalystwan/endpoints/configuration/policy/definition/vpn_qos_map.py +50 -0
  96. catalystwan/endpoints/configuration/policy/definition/zone_based_firewall.py +6 -11
  97. catalystwan/endpoints/configuration/policy/list/app.py +3 -16
  98. catalystwan/endpoints/configuration/policy/list/app_probe.py +6 -15
  99. catalystwan/endpoints/configuration/policy/list/as_path.py +3 -16
  100. catalystwan/endpoints/configuration/policy/list/class_map.py +3 -16
  101. catalystwan/endpoints/configuration/policy/list/color.py +3 -16
  102. catalystwan/endpoints/configuration/policy/list/community.py +3 -16
  103. catalystwan/endpoints/configuration/policy/list/data_ipv6_prefix.py +6 -15
  104. catalystwan/endpoints/configuration/policy/list/data_prefix.py +3 -16
  105. catalystwan/endpoints/configuration/policy/list/expanded_community.py +6 -15
  106. catalystwan/endpoints/configuration/policy/list/extended_community.py +52 -0
  107. catalystwan/endpoints/configuration/policy/list/fax_protocol.py +48 -0
  108. catalystwan/endpoints/configuration/policy/list/fqdn.py +3 -16
  109. catalystwan/endpoints/configuration/policy/list/geo_location.py +3 -16
  110. catalystwan/endpoints/configuration/policy/list/identity.py +48 -0
  111. catalystwan/endpoints/configuration/policy/list/ips_signature.py +6 -15
  112. catalystwan/endpoints/configuration/policy/list/ipv6_prefix.py +3 -16
  113. catalystwan/endpoints/configuration/policy/list/local_app.py +3 -16
  114. catalystwan/endpoints/configuration/policy/list/local_domain.py +3 -16
  115. catalystwan/endpoints/configuration/policy/list/media_profile.py +52 -0
  116. catalystwan/endpoints/configuration/policy/list/mirror.py +3 -16
  117. catalystwan/endpoints/configuration/policy/list/modem_pass_through.py +52 -0
  118. catalystwan/endpoints/configuration/policy/list/policer.py +3 -16
  119. catalystwan/endpoints/configuration/policy/list/port.py +3 -16
  120. catalystwan/endpoints/configuration/policy/list/preferred_color_group.py +6 -15
  121. catalystwan/endpoints/configuration/policy/list/prefix.py +4 -16
  122. catalystwan/endpoints/configuration/policy/list/protocol_name.py +6 -15
  123. catalystwan/endpoints/configuration/policy/list/region.py +2 -10
  124. catalystwan/endpoints/configuration/policy/list/scalable_group_tag.py +52 -0
  125. catalystwan/endpoints/configuration/policy/list/site.py +3 -16
  126. catalystwan/endpoints/configuration/policy/list/sla.py +3 -16
  127. catalystwan/endpoints/configuration/policy/list/supervisory_disconnect.py +52 -0
  128. catalystwan/endpoints/configuration/policy/list/threat_grid_api_key.py +52 -0
  129. catalystwan/endpoints/configuration/policy/list/tloc.py +3 -16
  130. catalystwan/endpoints/configuration/policy/list/translation_profile.py +52 -0
  131. catalystwan/endpoints/configuration/policy/list/translation_rules.py +52 -0
  132. catalystwan/endpoints/configuration/policy/list/trunkgroup.py +48 -0
  133. catalystwan/endpoints/configuration/policy/list/umbrella_data.py +52 -0
  134. catalystwan/endpoints/configuration/policy/list/url_allow_list.py +3 -16
  135. catalystwan/endpoints/configuration/policy/list/url_block_list.py +3 -16
  136. catalystwan/endpoints/configuration/policy/list/vpn.py +3 -16
  137. catalystwan/endpoints/configuration/policy/list/zone.py +3 -16
  138. catalystwan/endpoints/configuration/policy/security_template.py +2 -3
  139. catalystwan/endpoints/configuration/policy/voice_template.py +39 -0
  140. catalystwan/endpoints/configuration/policy_group.py +30 -0
  141. catalystwan/endpoints/configuration/software_actions.py +2 -4
  142. catalystwan/endpoints/configuration/topology_group.py +51 -0
  143. catalystwan/endpoints/configuration_dashboard_status.py +2 -2
  144. catalystwan/endpoints/configuration_device_template.py +15 -1
  145. catalystwan/endpoints/configuration_feature_profile.py +8 -11
  146. catalystwan/endpoints/configuration_general_template.py +31 -0
  147. catalystwan/endpoints/configuration_group.py +28 -5
  148. catalystwan/endpoints/configuration_settings.py +90 -1
  149. catalystwan/endpoints/configuration_template_master.py +48 -0
  150. catalystwan/endpoints/endpoints_container.py +79 -19
  151. catalystwan/endpoints/real_time_monitoring/reboot_history.py +1 -3
  152. catalystwan/endpoints/tenant_migration.py +2 -0
  153. catalystwan/exceptions.py +17 -0
  154. catalystwan/integration_tests/base.py +81 -0
  155. catalystwan/integration_tests/feature_profile/sdwan/__init__.py +0 -0
  156. catalystwan/integration_tests/feature_profile/sdwan/policy/__init__.py +0 -0
  157. catalystwan/integration_tests/feature_profile/sdwan/policy/base.py +33 -0
  158. catalystwan/integration_tests/feature_profile/sdwan/policy/test_extended_community.py +33 -0
  159. catalystwan/integration_tests/feature_profile/sdwan/policy/test_security_app_list.py +32 -0
  160. catalystwan/integration_tests/feature_profile/sdwan/test_application_priority.py +433 -0
  161. catalystwan/integration_tests/feature_profile/sdwan/test_cli.py +54 -0
  162. catalystwan/integration_tests/feature_profile/sdwan/test_dns_security.py +106 -0
  163. catalystwan/integration_tests/feature_profile/sdwan/test_other.py +49 -0
  164. catalystwan/integration_tests/feature_profile/sdwan/test_service.py +1078 -0
  165. catalystwan/integration_tests/feature_profile/sdwan/test_sig_security.py +322 -0
  166. catalystwan/integration_tests/feature_profile/sdwan/test_ssl_decryption.py +85 -0
  167. catalystwan/integration_tests/feature_profile/sdwan/test_system.py +368 -0
  168. catalystwan/integration_tests/feature_profile/sdwan/test_tracker.py +127 -0
  169. catalystwan/integration_tests/feature_profile/sdwan/test_transport.py +1698 -0
  170. catalystwan/integration_tests/feature_profile/sdwan/topology/test_topology.py +93 -0
  171. catalystwan/integration_tests/profile_builder/__init__.py +0 -0
  172. catalystwan/integration_tests/profile_builder/test_pb_service.py +197 -0
  173. catalystwan/integration_tests/profile_builder/test_pb_transport.py +226 -0
  174. catalystwan/integration_tests/profile_builder/test_pb_uc_voice.py +277 -0
  175. catalystwan/integration_tests/test_data/__init__.py +117 -0
  176. catalystwan/integration_tests/test_find_template_values.py +7 -18
  177. catalystwan/integration_tests/test_network_hierarchy.py +82 -0
  178. catalystwan/integration_tests/test_settings.py +30 -0
  179. catalystwan/models/common.py +1898 -2
  180. catalystwan/models/configuration/common.py +1 -0
  181. catalystwan/models/configuration/feature_profile/common.py +634 -149
  182. catalystwan/models/configuration/feature_profile/parcel.py +238 -0
  183. catalystwan/models/configuration/feature_profile/sdwan/acl/__init__.py +13 -0
  184. catalystwan/models/configuration/feature_profile/sdwan/acl/ipv4acl.py +298 -0
  185. catalystwan/models/configuration/feature_profile/sdwan/acl/ipv6acl.py +344 -0
  186. catalystwan/models/configuration/feature_profile/sdwan/application_priority/__init__.py +218 -0
  187. catalystwan/models/configuration/feature_profile/sdwan/application_priority/cloud_probe.py +61 -0
  188. catalystwan/models/configuration/feature_profile/sdwan/application_priority/policy_settings.py +31 -0
  189. catalystwan/models/configuration/feature_profile/sdwan/application_priority/qos_policy.py +102 -0
  190. catalystwan/models/configuration/feature_profile/sdwan/application_priority/traffic_policy.py +1057 -0
  191. catalystwan/models/configuration/feature_profile/sdwan/cli/__init__.py +23 -0
  192. catalystwan/models/configuration/feature_profile/sdwan/cli/config.py +18 -0
  193. catalystwan/models/configuration/feature_profile/sdwan/cli/full_config.py +15 -0
  194. catalystwan/models/configuration/feature_profile/sdwan/dns_security/__init__.py +13 -0
  195. catalystwan/models/configuration/feature_profile/sdwan/dns_security/dns.py +110 -0
  196. catalystwan/models/configuration/feature_profile/sdwan/embedded_security/__init__.py +23 -0
  197. catalystwan/models/configuration/feature_profile/sdwan/embedded_security/ngfirewall.py +493 -0
  198. catalystwan/models/configuration/feature_profile/sdwan/embedded_security/policy.py +171 -0
  199. catalystwan/models/configuration/feature_profile/sdwan/other/__init__.py +25 -0
  200. catalystwan/models/configuration/feature_profile/sdwan/other/cybervision.py +44 -0
  201. catalystwan/models/configuration/feature_profile/sdwan/other/thousandeyes.py +147 -0
  202. catalystwan/models/configuration/feature_profile/sdwan/other/ucse.py +110 -0
  203. catalystwan/models/configuration/feature_profile/sdwan/policy_object/__init__.py +62 -48
  204. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/app_probe.py +34 -20
  205. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/application_list.py +8 -6
  206. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/as_path.py +22 -0
  207. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/color_list.py +7 -5
  208. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/data_prefix.py +13 -4
  209. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/expanded_community_list.py +9 -7
  210. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/extended_community.py +34 -0
  211. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/fowarding_class.py +7 -5
  212. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/ipv4_network_object.py +15 -0
  213. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/ipv4_service_object.py +254 -0
  214. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/ipv6_data_prefix.py +11 -9
  215. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/ipv6_prefix_list.py +25 -10
  216. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/mirror.py +27 -0
  217. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/network_object_group.py +15 -0
  218. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/object_group.py +15 -0
  219. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/{policier.py → policer.py} +12 -10
  220. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/prefered_group_color.py +29 -10
  221. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/prefix_list.py +23 -8
  222. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/service_object_group.py +21 -0
  223. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/sla_class.py +12 -31
  224. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/standard_community.py +16 -10
  225. catalystwan/models/configuration/feature_profile/sdwan/policy_object/policy/tloc_list.py +8 -7
  226. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/aip.py +64 -0
  227. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/amp.py +79 -0
  228. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/application_list.py +8 -6
  229. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/data_prefix.py +7 -5
  230. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/fqdn.py +7 -5
  231. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/geolocation_list.py +7 -5
  232. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/identity.py +30 -0
  233. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/intrusion_prevention.py +58 -0
  234. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/ips_signature.py +7 -5
  235. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/local_domain.py +7 -5
  236. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/object_group.py +72 -0
  237. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/protocol_list.py +7 -5
  238. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/rule_set.py +137 -0
  239. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/scalable_group_tag.py +26 -0
  240. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/security_port.py +21 -11
  241. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/ssl_decryption.py +126 -0
  242. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/ssl_decryption_profile.py +165 -0
  243. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/url.py +15 -10
  244. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/url_filtering.py +148 -0
  245. catalystwan/models/configuration/feature_profile/sdwan/policy_object/security/zone.py +14 -18
  246. catalystwan/models/configuration/feature_profile/sdwan/routing/__init__.py +26 -0
  247. catalystwan/models/configuration/feature_profile/sdwan/routing/bgp.py +609 -0
  248. catalystwan/models/configuration/feature_profile/sdwan/{service → routing}/ospf.py +55 -47
  249. catalystwan/models/configuration/feature_profile/sdwan/{service → routing}/ospfv3.py +74 -72
  250. catalystwan/models/configuration/feature_profile/sdwan/service/__init__.py +91 -0
  251. catalystwan/models/configuration/feature_profile/sdwan/service/appqoe.py +76 -41
  252. catalystwan/models/configuration/feature_profile/sdwan/service/dhcp_server.py +107 -64
  253. catalystwan/models/configuration/feature_profile/sdwan/service/dual_router_ha.py +26 -0
  254. catalystwan/models/configuration/feature_profile/sdwan/service/eigrp.py +39 -42
  255. catalystwan/models/configuration/feature_profile/sdwan/service/lan/common.py +7 -88
  256. catalystwan/models/configuration/feature_profile/sdwan/service/lan/ethernet.py +231 -155
  257. catalystwan/models/configuration/feature_profile/sdwan/service/lan/gre.py +38 -108
  258. catalystwan/models/configuration/feature_profile/sdwan/service/lan/ipsec.py +77 -84
  259. catalystwan/models/configuration/feature_profile/sdwan/service/lan/multilink.py +101 -0
  260. catalystwan/models/configuration/feature_profile/sdwan/service/lan/svi.py +62 -56
  261. catalystwan/models/configuration/feature_profile/sdwan/service/lan/vpn.py +111 -120
  262. catalystwan/models/configuration/feature_profile/sdwan/service/multicast.py +56 -57
  263. catalystwan/models/configuration/feature_profile/sdwan/service/object_tracker.py +15 -21
  264. catalystwan/models/configuration/feature_profile/sdwan/service/route_policy.py +358 -110
  265. catalystwan/models/configuration/feature_profile/sdwan/service/service_chain.py +38 -0
  266. catalystwan/models/configuration/feature_profile/sdwan/service/service_insertion_attachment.py +17 -25
  267. catalystwan/models/configuration/feature_profile/sdwan/service/switchport.py +50 -58
  268. catalystwan/models/configuration/feature_profile/sdwan/service/tracker.py +12 -21
  269. catalystwan/models/configuration/feature_profile/sdwan/service/wireless_lan.py +27 -31
  270. catalystwan/models/configuration/feature_profile/sdwan/sig_security/__init__.py +19 -0
  271. catalystwan/models/configuration/feature_profile/sdwan/sig_security/sig_security.py +379 -0
  272. catalystwan/models/configuration/feature_profile/sdwan/system/__init__.py +59 -0
  273. catalystwan/models/configuration/feature_profile/sdwan/system/aaa.py +58 -10
  274. catalystwan/models/configuration/feature_profile/sdwan/system/banner.py +30 -0
  275. catalystwan/models/configuration/feature_profile/sdwan/system/basic.py +290 -0
  276. catalystwan/models/configuration/feature_profile/sdwan/system/bfd.py +69 -0
  277. catalystwan/models/configuration/feature_profile/sdwan/system/device_access.py +157 -0
  278. catalystwan/models/configuration/feature_profile/sdwan/system/device_access_ipv6.py +157 -0
  279. catalystwan/models/configuration/feature_profile/sdwan/system/global_parcel.py +163 -0
  280. catalystwan/models/configuration/feature_profile/sdwan/system/logging_parcel.py +162 -0
  281. catalystwan/models/configuration/feature_profile/sdwan/system/mrf.py +75 -0
  282. catalystwan/models/configuration/feature_profile/sdwan/system/ntp.py +103 -0
  283. catalystwan/models/configuration/feature_profile/sdwan/system/omp.py +120 -0
  284. catalystwan/models/configuration/feature_profile/sdwan/system/security.py +179 -0
  285. catalystwan/models/configuration/feature_profile/sdwan/system/snmp.py +173 -0
  286. catalystwan/models/configuration/feature_profile/sdwan/topology/__init__.py +29 -0
  287. catalystwan/models/configuration/feature_profile/sdwan/topology/custom_control.py +425 -0
  288. catalystwan/models/configuration/feature_profile/sdwan/topology/hubspoke.py +60 -0
  289. catalystwan/models/configuration/feature_profile/sdwan/topology/mesh.py +23 -0
  290. catalystwan/models/configuration/feature_profile/sdwan/trackers/__init__.py +36 -0
  291. catalystwan/models/configuration/feature_profile/sdwan/trackers/tracker.py +96 -0
  292. catalystwan/models/configuration/feature_profile/sdwan/trackers/tracker_group.py +63 -0
  293. catalystwan/models/configuration/feature_profile/sdwan/transport/__init__.py +93 -0
  294. catalystwan/models/configuration/feature_profile/sdwan/transport/cellular_controller.py +26 -23
  295. catalystwan/models/configuration/feature_profile/sdwan/transport/cellular_profile.py +71 -0
  296. catalystwan/models/configuration/feature_profile/sdwan/transport/gps.py +37 -0
  297. catalystwan/models/configuration/feature_profile/sdwan/transport/management/ethernet.py +121 -0
  298. catalystwan/models/configuration/feature_profile/sdwan/transport/t1e1controller.py +124 -0
  299. catalystwan/models/configuration/feature_profile/sdwan/transport/vpn.py +285 -0
  300. catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/cellular.py +173 -0
  301. catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/ethernet.py +389 -0
  302. catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/gre.py +46 -0
  303. catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/ipsec.py +137 -0
  304. catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/multilink.py +219 -0
  305. catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/protocol_over.py +405 -0
  306. catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/t1e1serial.py +195 -0
  307. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/__init__.py +62 -0
  308. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/analog_interface.py +436 -0
  309. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/call_routing.py +179 -0
  310. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/digital_interface.py +380 -0
  311. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/dsp_farm.py +193 -0
  312. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/media_profile.py +17 -0
  313. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/server_group.py +51 -0
  314. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/srst.py +86 -0
  315. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/supervisory_disconnect.py +69 -0
  316. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/translation_profile.py +42 -0
  317. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/translation_rule.py +31 -0
  318. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/trunk_group.py +26 -0
  319. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/voice_global.py +57 -0
  320. catalystwan/models/configuration/feature_profile/sdwan/uc_voice/voice_tenant.py +40 -0
  321. catalystwan/models/configuration/network_hierarchy/__init__.py +22 -0
  322. catalystwan/models/configuration/network_hierarchy/cflowd.py +120 -0
  323. catalystwan/models/configuration/network_hierarchy/node.py +88 -0
  324. catalystwan/models/configuration/policy_group.py +74 -0
  325. catalystwan/models/configuration/profile_type.py +1 -6
  326. catalystwan/models/configuration/topology_group.py +52 -0
  327. catalystwan/models/policy/__init__.py +275 -69
  328. catalystwan/models/policy/centralized.py +26 -29
  329. catalystwan/models/policy/{definitions → definition}/access_control_list.py +47 -17
  330. catalystwan/models/policy/{definitions → definition}/access_control_list_ipv6.py +42 -18
  331. catalystwan/models/policy/definition/aip.py +60 -0
  332. catalystwan/models/policy/definition/amp.py +65 -0
  333. catalystwan/models/policy/definition/app_route.py +246 -0
  334. catalystwan/models/policy/definition/cflowd.py +95 -0
  335. catalystwan/models/policy/{definitions → definition}/control.py +48 -25
  336. catalystwan/models/policy/{definitions → definition}/device_access.py +22 -11
  337. catalystwan/models/policy/{definitions → definition}/device_access_ipv6.py +20 -11
  338. catalystwan/models/policy/definition/dial_peer.py +60 -0
  339. catalystwan/models/policy/definition/dns_security.py +130 -0
  340. catalystwan/models/policy/definition/fxo_port.py +63 -0
  341. catalystwan/models/policy/definition/fxs_did_port.py +58 -0
  342. catalystwan/models/policy/definition/fxs_port.py +56 -0
  343. catalystwan/models/policy/{definitions → definition}/hub_and_spoke.py +18 -4
  344. catalystwan/models/policy/definition/intrusion_prevention.py +55 -0
  345. catalystwan/models/policy/{definitions → definition}/mesh.py +13 -1
  346. catalystwan/models/policy/definition/pri_isdn_port.py +48 -0
  347. catalystwan/models/policy/{definitions → definition}/qos_map.py +39 -32
  348. catalystwan/models/policy/{definitions → definition}/rewrite.py +12 -2
  349. catalystwan/models/policy/definition/route_policy.py +187 -0
  350. catalystwan/models/policy/{definitions → definition}/rule_set.py +66 -48
  351. catalystwan/models/policy/{definitions → definition}/security_group.py +38 -14
  352. catalystwan/models/policy/definition/srst_phone_profile.py +37 -0
  353. catalystwan/models/policy/definition/ssl_decryption.py +209 -0
  354. catalystwan/models/policy/definition/ssl_decryption_utd_profile.py +87 -0
  355. catalystwan/models/policy/{definitions → definition}/traffic_data.py +184 -61
  356. catalystwan/models/policy/definition/url_filtering.py +70 -0
  357. catalystwan/models/policy/{definitions → definition}/vpn_membership.py +13 -1
  358. catalystwan/models/policy/definition/vpn_qos_map.py +46 -0
  359. catalystwan/models/policy/{definitions → definition}/zone_based_firewall.py +93 -32
  360. catalystwan/models/policy/list/app.py +44 -0
  361. catalystwan/models/policy/list/app_probe.py +42 -0
  362. catalystwan/models/policy/list/as_path.py +30 -0
  363. catalystwan/models/policy/list/class_map.py +30 -0
  364. catalystwan/models/policy/list/color.py +28 -0
  365. catalystwan/models/policy/list/communities.py +83 -0
  366. catalystwan/models/policy/list/data_ipv6_prefix.py +30 -0
  367. catalystwan/models/policy/list/data_prefix.py +30 -0
  368. catalystwan/models/policy/list/fax_protocol.py +45 -0
  369. catalystwan/models/policy/list/fqdn.py +24 -0
  370. catalystwan/models/policy/list/geo_location.py +33 -0
  371. catalystwan/models/policy/list/identity.py +29 -0
  372. catalystwan/models/policy/list/ips_signature.py +27 -0
  373. catalystwan/models/policy/list/ipv6_prefix.py +33 -0
  374. catalystwan/models/policy/list/local_app.py +45 -0
  375. catalystwan/models/policy/list/local_domain.py +36 -0
  376. catalystwan/models/policy/list/media_profile.py +44 -0
  377. catalystwan/models/policy/list/mirror.py +27 -0
  378. catalystwan/models/policy/list/modem_pass_through.py +27 -0
  379. catalystwan/models/policy/list/policer.py +39 -0
  380. catalystwan/models/policy/list/port.py +33 -0
  381. catalystwan/models/policy/list/preferred_color_group.py +82 -0
  382. catalystwan/models/policy/list/prefix.py +33 -0
  383. catalystwan/models/policy/list/protocol_name.py +26 -0
  384. catalystwan/models/policy/list/region.py +45 -0
  385. catalystwan/models/policy/list/scalable_group_tag.py +30 -0
  386. catalystwan/models/policy/list/site.py +34 -0
  387. catalystwan/models/policy/list/sla.py +77 -0
  388. catalystwan/models/policy/list/supervisory_disconnect.py +62 -0
  389. catalystwan/models/policy/list/threat_grid_api_key.py +32 -0
  390. catalystwan/models/policy/list/tloc.py +32 -0
  391. catalystwan/models/policy/list/translation_profile.py +32 -0
  392. catalystwan/models/policy/list/translation_rules.py +29 -0
  393. catalystwan/models/policy/list/trunkgroup.py +56 -0
  394. catalystwan/models/policy/list/umbrella_data.py +30 -0
  395. catalystwan/models/policy/list/url.py +39 -0
  396. catalystwan/models/policy/list/vpn.py +40 -0
  397. catalystwan/models/policy/list/zone.py +46 -0
  398. catalystwan/models/policy/localized.py +34 -16
  399. catalystwan/models/policy/policy.py +13 -9
  400. catalystwan/models/policy/policy_definition.py +673 -173
  401. catalystwan/models/policy/policy_list.py +38 -27
  402. catalystwan/models/policy/security.py +145 -46
  403. catalystwan/models/policy/voice.py +77 -0
  404. catalystwan/models/settings.py +41 -0
  405. catalystwan/models/templates.py +79 -0
  406. catalystwan/response.py +6 -2
  407. catalystwan/session.py +1 -1
  408. catalystwan/tests/builders/test_report.py +60 -0
  409. catalystwan/tests/builders/uc_voice.py +85 -0
  410. catalystwan/tests/models/__init__.py +0 -0
  411. catalystwan/tests/models/test_digital_interface.py +56 -0
  412. catalystwan/tests/templates/definitions/aaa_basic.json +96 -0
  413. catalystwan/tests/templates/definitions/aaa_complex.json +464 -0
  414. catalystwan/tests/templates/definitions/{iuo.json → cisco_aaa.json} +44 -15
  415. catalystwan/tests/templates/definitions/cisco_aaa_complex.json +361 -0
  416. catalystwan/tests/templates/definitions/cisco_logging_complex.json +268 -0
  417. catalystwan/tests/templates/definitions/cisco_ntp_complex.json +143 -0
  418. catalystwan/tests/templates/definitions/cisco_omp_complex.json +175 -0
  419. catalystwan/tests/templates/definitions/cisco_ospf_complex.json +302 -0
  420. catalystwan/tests/templates/definitions/cisco_sig.json +405 -0
  421. catalystwan/tests/templates/definitions/cisco_snmp_complex.json +258 -0
  422. catalystwan/tests/templates/definitions/cisco_system_complex.json +502 -0
  423. catalystwan/tests/templates/definitions/{Basic_Cisco_VPN_Model.json → cisco_vpn_basic.json} +2 -2
  424. catalystwan/tests/templates/definitions/{complex_cisco_vpn.json → cisco_vpn_complex.json} +27 -12
  425. catalystwan/tests/templates/definitions/cisco_vpn_interface_complex.json +821 -0
  426. catalystwan/tests/templates/definitions/omp_vsmart_1.json +26 -0
  427. catalystwan/tests/templates/definitions/{omp_2.json → omp_vsmart_2.json} +16 -2
  428. catalystwan/tests/templates/definitions/{omp_3.json → omp_vsmart_3.json} +16 -2
  429. catalystwan/tests/templates/definitions/omp_vsmart_complex.json +73 -0
  430. catalystwan/tests/templates/definitions/security_vsmart_complex.json +24 -0
  431. catalystwan/tests/templates/definitions/system_vsmart_complex.json +193 -0
  432. catalystwan/tests/templates/definitions/vpn_vsmart_basic.json +17 -0
  433. catalystwan/tests/templates/definitions/vpn_vsmart_complex.json +179 -0
  434. catalystwan/tests/templates/definitions/vpn_vsmart_interface_basic.json +42 -0
  435. catalystwan/tests/templates/definitions/vpn_vsmart_interface_complex.json +208 -0
  436. catalystwan/tests/templates/models/__init__.py +46 -13
  437. catalystwan/tests/templates/models/aaa.py +106 -0
  438. catalystwan/tests/templates/models/cisco_aaa.py +81 -48
  439. catalystwan/tests/templates/models/cisco_banner.py +2 -2
  440. catalystwan/tests/templates/models/cisco_bfd.py +4 -6
  441. catalystwan/tests/templates/models/cisco_logging.py +65 -0
  442. catalystwan/tests/templates/models/cisco_ntp.py +17 -0
  443. catalystwan/tests/templates/models/cisco_omp.py +37 -0
  444. catalystwan/tests/templates/models/cisco_ospf.py +60 -0
  445. catalystwan/tests/templates/models/cisco_secure_internet_gateway.py +95 -0
  446. catalystwan/tests/templates/models/cisco_snmp.py +40 -0
  447. catalystwan/tests/templates/models/cisco_system.py +108 -3
  448. catalystwan/tests/templates/models/cisco_vpn.py +42 -72
  449. catalystwan/tests/templates/models/cisco_vpn_interface.py +200 -0
  450. catalystwan/tests/templates/models/omp_vsmart.py +28 -8
  451. catalystwan/tests/templates/models/security_vsmart.py +11 -0
  452. catalystwan/tests/templates/models/system_vsmart.py +37 -0
  453. catalystwan/tests/templates/models/vpn_vsmart.py +32 -0
  454. catalystwan/tests/templates/models/vpn_vsmart_interface.py +54 -0
  455. catalystwan/tests/templates/schemas/aaa.json +1096 -0
  456. catalystwan/tests/templates/schemas/cedge_aaa.json +1 -1
  457. catalystwan/tests/templates/schemas/cisco_logging.json +577 -0
  458. catalystwan/tests/templates/schemas/cisco_ntp.json +265 -0
  459. catalystwan/tests/templates/schemas/cisco_omp.json +479 -0
  460. catalystwan/tests/templates/schemas/cisco_ospf.json +908 -0
  461. catalystwan/tests/templates/schemas/cisco_secure_internet_gateway.json +1520 -0
  462. catalystwan/tests/templates/schemas/cisco_snmp.json +561 -0
  463. catalystwan/tests/templates/schemas/cisco_system.json +242 -0
  464. catalystwan/tests/templates/schemas/cisco_vpn.json +53 -1
  465. catalystwan/tests/templates/schemas/cisco_vpn_interface.json +3348 -0
  466. catalystwan/tests/templates/schemas/omp-vsmart.json +20 -0
  467. catalystwan/tests/templates/schemas/security-vsmart.json +58 -0
  468. catalystwan/tests/templates/schemas/system-vsmart.json +2585 -0
  469. catalystwan/tests/templates/schemas/vpn-vsmart-interface.json +859 -0
  470. catalystwan/tests/templates/schemas/vpn-vsmart.json +445 -0
  471. catalystwan/tests/templates/test_chose_model.py +6 -10
  472. catalystwan/tests/templates/test_deserialize_model.py +4 -4
  473. catalystwan/tests/templates/test_find_template_values.py +229 -0
  474. catalystwan/tests/templates/test_find_template_values_2.py +193 -0
  475. catalystwan/tests/templates/test_serialize_model.py +1 -2
  476. catalystwan/tests/test_cli_template.py +8 -9
  477. catalystwan/tests/test_endpoints.py +42 -11
  478. catalystwan/tests/test_feature_profile_api.py +282 -0
  479. catalystwan/tests/test_models_common.py +53 -0
  480. catalystwan/tests/test_templates.py +16 -19
  481. catalystwan/utils/feature_template/find_template_values.py +17 -4
  482. catalystwan/utils/model.py +45 -0
  483. catalystwan/utils/persona.py +5 -0
  484. catalystwan/utils/type_check.py +22 -0
  485. catalystwan/workflows/backup_restore_device_templates.py +467 -0
  486. catalystwan/workflows/tenant_migration.py +1 -1
  487. {catalystwan-0.41.2.dist-info → catalystwan-0.41.2.dev1.dist-info}/METADATA +20 -1
  488. catalystwan-0.41.2.dev1.dist-info/RECORD +636 -0
  489. catalystwan/ENDPOINTS.md +0 -611
  490. catalystwan/api/configuration_groups/parcels/cellular_controller.py +0 -33
  491. catalystwan/api/templates/device_template/device_template_payload.json.j2 +0 -19
  492. catalystwan/models/configuration/config_migration.py +0 -36
  493. catalystwan/models/configuration/feature_profile/sdwan/management/vpn.py +0 -26
  494. catalystwan/models/configuration/feature_profile/sdwan/service/acl.py +0 -409
  495. catalystwan/models/configuration/feature_profile/sdwan/service/bgp.py +0 -288
  496. catalystwan/models/policy/lists.py +0 -330
  497. catalystwan/models/policy/lists_entries.py +0 -444
  498. catalystwan/tests/templates/definitions/complex_aaa.json +0 -277
  499. catalystwan/tests/templates/definitions/omp_1.json +0 -11
  500. catalystwan/utils/timezone.py +0 -422
  501. catalystwan-0.41.2.dist-info/RECORD +0 -353
  502. /catalystwan/tests/templates/definitions/{banner_1.json → cisco_banner.json} +0 -0
  503. {catalystwan-0.41.2.dist-info → catalystwan-0.41.2.dev1.dist-info}/LICENSE +0 -0
  504. {catalystwan-0.41.2.dist-info → catalystwan-0.41.2.dev1.dist-info}/WHEEL +0 -0
@@ -0,0 +1,425 @@
1
+ # Copyright 2024 Cisco Systems, Inc. and its affiliates
2
+ from ipaddress import IPv4Address
3
+ from typing import Any, Dict, List, Literal, Optional, overload
4
+ from uuid import UUID
5
+
6
+ from pydantic import (
7
+ AliasPath,
8
+ BaseModel,
9
+ ConfigDict,
10
+ Field,
11
+ SerializationInfo,
12
+ SerializerFunctionWrapHandler,
13
+ model_serializer,
14
+ model_validator,
15
+ )
16
+ from typing_extensions import Annotated
17
+
18
+ from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_global
19
+ from catalystwan.models.common import (
20
+ AcceptRejectActionType,
21
+ CarrierType,
22
+ ControlPathType,
23
+ EncapType,
24
+ MultiRegionRole,
25
+ OriginProtocol,
26
+ SequenceIpType,
27
+ ServiceChainNumber,
28
+ ServiceType,
29
+ TLOCActionType,
30
+ TLOCColor,
31
+ VersionedField,
32
+ check_fields_exclusive,
33
+ )
34
+ from catalystwan.models.configuration.feature_profile.common import RefIdItem
35
+
36
+ Level = Literal[
37
+ "REGION",
38
+ "SITE",
39
+ "SUB_REGION",
40
+ ]
41
+
42
+ ControlSequenceType = Literal[
43
+ "route",
44
+ "tloc",
45
+ ]
46
+
47
+
48
+ class Region(BaseModel):
49
+ model_config = ConfigDict(populate_by_name=True)
50
+ region: Optional[Global[str]] = Field(default=None)
51
+ sub_region: Optional[Global[List[str]]] = Field(
52
+ default=None, validation_alias="subRegion", serialization_alias="subRegion"
53
+ )
54
+
55
+
56
+ class Target(BaseModel):
57
+ model_config = ConfigDict(populate_by_name=True)
58
+ inbound_regions: Optional[List[Region]] = Field(
59
+ default=None, validation_alias="inboundRegions", serialization_alias="inboundRegions"
60
+ )
61
+ inbound_sites: Optional[Global[List[str]]] = Field(
62
+ default=None, validation_alias="inboundSites", serialization_alias="inboundSites"
63
+ )
64
+ level: Annotated[Optional[Global[Level]], VersionedField(versions="<20.15", forbidden=True)] = Field(default=None)
65
+ outbound_regions: Optional[List[Region]] = Field(
66
+ default=None, validation_alias="outboundRegions", serialization_alias="outboundRegions"
67
+ )
68
+ outbound_sites: Optional[Global[List[str]]] = Field(
69
+ default=None, validation_alias="outboundSites", serialization_alias="outboundSites"
70
+ )
71
+ vpn: Optional[Global[List[str]]] = Field(default=None)
72
+
73
+ @model_serializer(mode="wrap", when_used="json")
74
+ def serialize(self, handler: SerializerFunctionWrapHandler, info: SerializationInfo) -> Dict[str, Any]:
75
+ return VersionedField.dump(self.model_fields, handler(self), info)
76
+
77
+
78
+ class Tloc(BaseModel):
79
+ model_config = ConfigDict(populate_by_name=True)
80
+ color: Optional[Global[TLOCColor]] = Field(default=None)
81
+ encap: Optional[Global[EncapType]] = Field(default=None)
82
+ ip: Optional[Global[str]] = Field(default=None)
83
+
84
+ @staticmethod
85
+ def from_params(color: TLOCColor, encap: EncapType, ip: IPv4Address) -> "Tloc":
86
+ _color = as_global(color, TLOCColor)
87
+ _encap = as_global(encap, EncapType)
88
+ _ip = as_global(str(ip))
89
+ return Tloc(color=_color, encap=_encap, ip=_ip)
90
+
91
+
92
+ class Entry(BaseModel):
93
+ model_config = ConfigDict(populate_by_name=True)
94
+ carrier: Optional[Global[CarrierType]] = Field(default=None)
95
+ color_list: Optional[RefIdItem] = Field(default=None, validation_alias="colorList", serialization_alias="colorList")
96
+ community: Optional[RefIdItem] = Field(default=None)
97
+ domain_id: Optional[Global[int]] = Field(default=None, validation_alias="domainId", serialization_alias="domainId")
98
+ expanded_community: Optional[RefIdItem] = Field(
99
+ default=None, validation_alias="expandedCommunity", serialization_alias="expandedCommunity"
100
+ )
101
+ group_id: Optional[Global[int]] = Field(default=None, validation_alias="groupId", serialization_alias="groupId")
102
+ ipv6prefix_list: Optional[RefIdItem] = Field(
103
+ default=None, validation_alias="ipv6prefixList", serialization_alias="ipv6prefixList"
104
+ )
105
+ omp_tag: Optional[Global[int]] = Field(default=None, validation_alias="ompTag", serialization_alias="ompTag")
106
+ origin: Optional[Global[OriginProtocol]] = Field(default=None)
107
+ originator: Optional[Global[str]] = Field(default=None)
108
+ path_type: Optional[Global[ControlPathType]] = Field(
109
+ default=None, validation_alias="pathType", serialization_alias="pathType"
110
+ )
111
+ preference: Optional[Global[int]] = Field(default=None)
112
+ prefix_list: Optional[RefIdItem] = Field(
113
+ default=None, validation_alias="prefixList", serialization_alias="prefixList"
114
+ )
115
+ regions: Optional[List[Region]] = Field(default=None)
116
+ role: Optional[Global[MultiRegionRole]] = Field(default=None)
117
+ site: Optional[Global[List[str]]] = Field(default=None)
118
+ tloc: Optional[Tloc] = Field(default=None)
119
+ tloc_list: Optional[RefIdItem] = Field(default=None, validation_alias="tlocList", serialization_alias="tlocList")
120
+ vpn: Optional[Global[List[str]]] = Field(default=None)
121
+
122
+
123
+ class Match(BaseModel):
124
+ model_config = ConfigDict(populate_by_name=True)
125
+ entries: List[Entry] = Field()
126
+
127
+
128
+ class Service(BaseModel):
129
+ model_config = ConfigDict(populate_by_name=True)
130
+ tloc: Optional[Tloc] = Field(default=None)
131
+ tloc_list: Optional[RefIdItem] = Field(default=None, validation_alias="tlocList", serialization_alias="tlocList")
132
+ type: Optional[Global[ServiceType]] = Field(default=None)
133
+ vpn: Optional[Global[int]] = Field(default=None)
134
+
135
+ @model_validator(mode="after")
136
+ def tloc_xor_tloc_list(self):
137
+ check_fields_exclusive(self.__dict__, {"tloc", "tloc_list"}, True)
138
+ return self
139
+
140
+
141
+ class ServiceChain(BaseModel):
142
+ model_config = ConfigDict(populate_by_name=True)
143
+ tloc: Optional[Tloc] = Field(default=None)
144
+ tloc_list: Optional[RefIdItem] = Field(default=None, validation_alias="tlocList", serialization_alias="tlocList")
145
+ type: Optional[Global[ServiceChainNumber]] = Field(default=None)
146
+ vpn: Optional[Global[int]] = Field(default=None)
147
+
148
+ @model_validator(mode="after")
149
+ def tloc_nand_tloc_list(self):
150
+ check_fields_exclusive(self.__dict__, {"tloc", "tloc_list"}, False)
151
+ return self
152
+
153
+
154
+ class ActionSet(BaseModel):
155
+ model_config = ConfigDict(populate_by_name=True)
156
+ affinity: Optional[Global[int]] = Field(default=None)
157
+ community: Optional[Global[str]] = Field(default=None)
158
+ community_additive: Optional[Global[bool]] = Field(
159
+ default=None, validation_alias="communityAdditive", serialization_alias="communityAdditive"
160
+ )
161
+ omp_tag: Optional[Global[int]] = Field(default=None, validation_alias="ompTag", serialization_alias="ompTag")
162
+ preference: Optional[Global[int]] = Field(default=None)
163
+ service: Optional[Service] = Field(default=None)
164
+ service_chain: Optional[ServiceChain] = Field(
165
+ default=None, validation_alias="serviceChain", serialization_alias="serviceChain"
166
+ )
167
+ tloc: Optional[Tloc] = Field(default=None)
168
+ tloc_action: Optional[Global[TLOCActionType]] = Field(
169
+ default=None, validation_alias="tlocAction", serialization_alias="tlocAction"
170
+ )
171
+ tloc_list: Optional[RefIdItem] = Field(default=None, validation_alias="tlocList", serialization_alias="tlocList")
172
+
173
+
174
+ class Actions(BaseModel):
175
+ model_config = ConfigDict(populate_by_name=True)
176
+ export_to: Optional[Global[List[str]]] = Field(
177
+ default=None, validation_alias="exportTo", serialization_alias="exportTo"
178
+ )
179
+ set: Optional[List[ActionSet]] = Field(default=None)
180
+
181
+
182
+ class Sequence(BaseModel):
183
+ model_config = ConfigDict(populate_by_name=True)
184
+ actions: Optional[List[Actions]] = Field(default=None)
185
+ base_action: Optional[Global[AcceptRejectActionType]] = Field(
186
+ default=None, validation_alias="baseAction", serialization_alias="baseAction"
187
+ )
188
+ match: Optional[Match] = Field(default=None)
189
+ sequence_id: Optional[Global[int]] = Field(
190
+ default=None, validation_alias="sequenceId", serialization_alias="sequenceId"
191
+ )
192
+ sequence_ip_type: Optional[Global[SequenceIpType]] = Field(
193
+ default=None, validation_alias="sequenceIpType", serialization_alias="sequenceIpType"
194
+ )
195
+ sequence_name: Optional[Global[str]] = Field(
196
+ default=None, validation_alias="sequenceName", serialization_alias="sequenceName"
197
+ )
198
+ sequence_type: Optional[Global[ControlSequenceType]] = Field(
199
+ default=None, validation_alias="sequenceType", serialization_alias="sequenceType"
200
+ )
201
+
202
+ def _get_match(self) -> Match:
203
+ if self.match is None:
204
+ self.match = Match(entries=[])
205
+ if self.match.entries is None:
206
+ self.match.entries = []
207
+ return self.match
208
+
209
+ def _match(self, entry: Entry):
210
+ self._get_match().entries.append(entry)
211
+
212
+ def _get_regions_entry(self) -> Entry:
213
+ entries = self._get_match().entries
214
+ for entry in entries:
215
+ if entry.regions is not None:
216
+ return entry
217
+ entry = Entry()
218
+ entries.append(entry)
219
+ return entry
220
+
221
+ @property
222
+ def _action(self) -> Actions:
223
+ if not self.actions:
224
+ self.actions = [Actions()]
225
+ return self.actions[0]
226
+
227
+ @property
228
+ def _action_set(self) -> ActionSet:
229
+ action = self._action
230
+ if action.set is None:
231
+ action.set = [ActionSet()]
232
+ return action.set[0]
233
+
234
+ def match_carrier(self, carrier: CarrierType):
235
+ entry = Entry(carrier=as_global(carrier, CarrierType))
236
+ self._match(entry)
237
+
238
+ def match_color_list(self, list_id: UUID):
239
+ entry = Entry(color_list=RefIdItem(ref_id=as_global(str(list_id))))
240
+ self._match(entry)
241
+
242
+ def match_community(self, list_id: UUID):
243
+ entry = Entry(community=RefIdItem(ref_id=as_global(str(list_id))))
244
+ self._match(entry)
245
+
246
+ def match_domain_id(self, domain_id: int):
247
+ entry = Entry(domain_id=as_global(domain_id))
248
+ self._match(entry)
249
+
250
+ def match_expanded_community(self, list_id: UUID):
251
+ entry = Entry(expanded_community=RefIdItem(ref_id=as_global(str(list_id))))
252
+ self._match(entry)
253
+
254
+ def match_group_id(self, group_id: int):
255
+ entry = Entry(group_id=as_global(group_id))
256
+ self._match(entry)
257
+
258
+ def match_ipv6prefix_list(self, list_id: UUID):
259
+ entry = Entry(ipv6prefix_list=RefIdItem(ref_id=as_global(str(list_id))))
260
+ self._match(entry)
261
+
262
+ def match_omp_tag(self, omp_tag: int):
263
+ entry = Entry(omp_tag=as_global(omp_tag))
264
+ self._match(entry)
265
+
266
+ def match_origin(self, origin: OriginProtocol):
267
+ entry = Entry(origin=as_global(origin, OriginProtocol))
268
+ self._match(entry)
269
+
270
+ def match_originator(self, originator: IPv4Address):
271
+ entry = Entry(originator=as_global(str(originator)))
272
+ self._match(entry)
273
+
274
+ def match_path_type(self, path_type: ControlPathType):
275
+ entry = Entry(path_type=as_global(path_type, ControlPathType))
276
+ self._match(entry)
277
+
278
+ def match_preference(self, preference: int):
279
+ entry = Entry(preference=as_global(preference))
280
+ self._match(entry)
281
+
282
+ def match_prefix_list(self, list_id: UUID):
283
+ entry = Entry(prefix_list=RefIdItem(ref_id=as_global(str(list_id))))
284
+ self._match(entry)
285
+
286
+ def match_region(self, region: str, subregions: Optional[List[str]] = None):
287
+ _region = Region(
288
+ region=as_global(region),
289
+ sub_region=as_global(subregions) if subregions else None,
290
+ )
291
+ entry = self._get_regions_entry()
292
+ if entry.regions:
293
+ entry.regions.append(_region)
294
+ else:
295
+ entry.regions = [_region]
296
+
297
+ def match_role(self, role: MultiRegionRole):
298
+ entry = Entry(role=as_global(role, MultiRegionRole))
299
+ self._match(entry)
300
+
301
+ def match_sites(self, sites: List[str]):
302
+ entry = Entry(site=as_global(sites))
303
+ self._match(entry)
304
+
305
+ def match_tloc(self, ip: IPv4Address, color: TLOCColor, encap: EncapType):
306
+ entry = Entry(
307
+ tloc=Tloc(color=as_global(color, TLOCColor), encap=as_global(encap, EncapType), ip=as_global(str(ip)))
308
+ )
309
+ self._match(entry)
310
+
311
+ def match_tloc_list(self, list_id: UUID):
312
+ entry = Entry(tloc_list=RefIdItem(ref_id=as_global(str(list_id))))
313
+ self._match(entry)
314
+
315
+ def match_vpns(self, vpns: List[str]):
316
+ entry = Entry(vpn=as_global(vpns))
317
+ self._match(entry)
318
+
319
+ def associate_affinitty_action(self, affinity: int) -> None:
320
+ self._action_set.affinity = as_global(affinity)
321
+
322
+ def associate_community_additive_action(self, additive: bool) -> None:
323
+ self._action_set.community_additive = as_global(additive)
324
+
325
+ def associate_community_action(self, community: str) -> None:
326
+ self._action_set.community = as_global(community)
327
+
328
+ def associate_omp_tag_action(self, omp_tag: int) -> None:
329
+ self._action_set.omp_tag = as_global(omp_tag)
330
+
331
+ def associate_preference_action(self, preference: int) -> None:
332
+ self._action_set.preference = as_global(preference)
333
+
334
+ @overload
335
+ def associate_service_action(self, service_type: ServiceType, vpn: Optional[int], *, tloc_list_id: UUID) -> None:
336
+ ...
337
+
338
+ @overload
339
+ def associate_service_action(
340
+ self, service_type: ServiceType, vpn: Optional[int], *, ip: IPv4Address, color: TLOCColor, encap: EncapType
341
+ ) -> None:
342
+ ...
343
+
344
+ def associate_service_action(
345
+ self, service_type=ServiceType, vpn=Optional[int], *, tloc_list_id=None, ip=None, color=None, encap=None
346
+ ) -> None:
347
+ _vpn = as_global(vpn) if vpn is not None else None
348
+ _service_type = as_global(service_type, ServiceType)
349
+ if tloc_list_id is not None:
350
+ service = Service(
351
+ tloc_list=RefIdItem(ref_id=as_global(str(tloc_list_id))),
352
+ type=_service_type,
353
+ vpn=_vpn,
354
+ )
355
+ else:
356
+ _tloc = Tloc.from_params(color=color, encap=encap, ip=ip)
357
+ service = Service(tloc=_tloc, type=_service_type, vpn=_vpn)
358
+ self._action_set.service = service
359
+
360
+ def associate_tloc(self, color: TLOCColor, encap: EncapType, ip: IPv4Address) -> None:
361
+ self._action_set.tloc = Tloc.from_params(color=color, encap=encap, ip=ip)
362
+
363
+ def associate_tloc_action(self, tloc_action_type: TLOCActionType) -> None:
364
+ self._action_set.tloc_action = as_global(tloc_action_type, TLOCActionType)
365
+
366
+ def associate_tloc_list(self, tloc_list_id: UUID) -> None:
367
+ self._action_set.tloc_list = RefIdItem(ref_id=as_global(str(tloc_list_id)))
368
+
369
+
370
+ class CustomControlParcel(_ParcelBase):
371
+ model_config = ConfigDict(populate_by_name=True)
372
+ type_: Literal["custom-control"] = Field(default="custom-control", exclude=True)
373
+ default_action: Optional[Global[AcceptRejectActionType]] = Field(
374
+ default=None, validation_alias=AliasPath("data", "defaultAction")
375
+ )
376
+ sequences: Optional[List[Sequence]] = Field(
377
+ default=None,
378
+ validation_alias=AliasPath("data", "sequences"),
379
+ description="Sequence list",
380
+ )
381
+ target: Optional[Target] = Field(
382
+ default=None,
383
+ validation_alias=AliasPath("data", "target"),
384
+ description="Target",
385
+ )
386
+
387
+ def set_default_action(self, action: AcceptRejectActionType = "reject"):
388
+ self.default_action = as_global(action, AcceptRejectActionType)
389
+
390
+ def assign_target_sites(
391
+ self,
392
+ inbound_sites: List[str],
393
+ outbound_sites: List[str],
394
+ _dummy_vpns: Optional[
395
+ List[str]
396
+ ], # mitigate a bug (vpn is not used but value needs to be provided for server to accept the message)
397
+ ) -> Target:
398
+ self.target = Target(
399
+ vpn=Global[List[str]](value=_dummy_vpns) if _dummy_vpns is not None else None,
400
+ level=as_global("SITE", Level),
401
+ inbound_sites=as_global(inbound_sites),
402
+ outbound_sites=as_global(outbound_sites),
403
+ )
404
+ return self.target
405
+
406
+ def add_sequence(
407
+ self,
408
+ name: str,
409
+ id_: int,
410
+ type_: ControlSequenceType,
411
+ ip_type: SequenceIpType,
412
+ base_action: AcceptRejectActionType,
413
+ ) -> Sequence:
414
+ seq = Sequence(
415
+ base_action=as_global(base_action, AcceptRejectActionType),
416
+ sequence_id=as_global(id_),
417
+ sequence_ip_type=as_global(ip_type, SequenceIpType),
418
+ sequence_name=as_global(name),
419
+ sequence_type=as_global(type_, ControlSequenceType),
420
+ )
421
+ if self.sequences is None:
422
+ self.sequences = [seq]
423
+ else:
424
+ self.sequences.append(seq)
425
+ return seq
@@ -0,0 +1,60 @@
1
+ # Copyright 2024 Cisco Systems, Inc. and its affiliates
2
+ from typing import List, Literal, Optional
3
+
4
+ from pydantic import AliasPath, BaseModel, ConfigDict, Field
5
+
6
+ from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_global
7
+
8
+
9
+ class Target(BaseModel):
10
+ vpn: Global[List[str]] = as_global([])
11
+
12
+
13
+ class HubSite(BaseModel):
14
+ sites: Global[List[str]]
15
+ preference: Global[int]
16
+
17
+
18
+ class Spoke(BaseModel):
19
+ model_config = ConfigDict(populate_by_name=True)
20
+ name: Global[str]
21
+ spoke_sites: Global[List[str]] = Field(
22
+ default=as_global([]), validation_alias="spokeSites", serialization_alias="spokeSites"
23
+ )
24
+ hub_sites: Optional[List[HubSite]] = Field(
25
+ default=None, validation_alias="hubSites", serialization_alias="hubSites"
26
+ )
27
+
28
+ @staticmethod
29
+ def create(name: str, spoke_sites: List[str]) -> "Spoke":
30
+ return Spoke(name=as_global(name), spoke_sites=Global[List[str]](value=spoke_sites))
31
+
32
+ def add_hub_site(self, sites: List[str], preference: int) -> HubSite:
33
+ hub_site = HubSite(sites=Global[List[str]](value=sites), preference=as_global(preference))
34
+ if self.hub_sites is None:
35
+ self.hub_sites = [hub_site]
36
+ else:
37
+ self.hub_sites.append(hub_site)
38
+ return hub_site
39
+
40
+ def add_spoke_site(self, site: str):
41
+ self.spoke_sites.value.append(site)
42
+
43
+
44
+ class HubSpokeParcel(_ParcelBase):
45
+ model_config = ConfigDict(populate_by_name=True)
46
+ type_: Literal["hubspoke"] = Field(default="hubspoke", exclude=True)
47
+ target: Target = Field(default=Target(), validation_alias=AliasPath("data", "target"))
48
+ selected_hubs: Global[List[str]] = Field(default=as_global([]), validation_alias=AliasPath("data", "selectedHubs"))
49
+ spokes: List[Spoke] = Field(default_factory=list, validation_alias=AliasPath("data", "spokes"))
50
+
51
+ def add_spoke(self, name: str, spoke_sites: List[str]) -> Spoke:
52
+ spoke = Spoke.create(name=name, spoke_sites=spoke_sites)
53
+ self.spokes.append(spoke)
54
+ return spoke
55
+
56
+ def add_target_vpn(self, vpn: str) -> None:
57
+ self.target.vpn.value.append(vpn)
58
+
59
+ def add_selected_hub(self, hub: str) -> None:
60
+ self.selected_hubs.value.append(hub)
@@ -0,0 +1,23 @@
1
+ # Copyright 2024 Cisco Systems, Inc. and its affiliates
2
+ from typing import List, Literal
3
+
4
+ from pydantic import AliasPath, BaseModel, ConfigDict, Field
5
+
6
+ from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_global
7
+
8
+
9
+ class Target(BaseModel):
10
+ vpn: Global[List[str]] = as_global([])
11
+
12
+
13
+ class MeshParcel(_ParcelBase):
14
+ model_config = ConfigDict(populate_by_name=True)
15
+ type_: Literal["mesh"] = Field(default="mesh", exclude=True)
16
+ target: Target = Field(default=Target(), validation_alias=AliasPath("data", "target"), description="Target Vpn")
17
+ sites: Global[List[str]] = Field(default=as_global([]), validation_alias=AliasPath("data", "sites"))
18
+
19
+ def add_target_vpn(self, vpn: str) -> None:
20
+ self.target.vpn.value.append(vpn)
21
+
22
+ def add_site(self, site: str) -> None:
23
+ self.sites.value.append(site)
@@ -0,0 +1,36 @@
1
+ # Copyright 2025 Cisco Systems, Inc. and its affiliates
2
+ from typing import List, Union
3
+
4
+ from pydantic import Field
5
+ from typing_extensions import Annotated
6
+
7
+ from catalystwan.models.configuration.feature_profile.sdwan.trackers.tracker import (
8
+ EndpointTcpUdp,
9
+ EndpointTrackerType,
10
+ Tracker,
11
+ TrackerIPv6,
12
+ )
13
+ from catalystwan.models.configuration.feature_profile.sdwan.trackers.tracker_group import (
14
+ TrackerGroup,
15
+ TrackerGroupIPv6,
16
+ TrackerRefs,
17
+ )
18
+
19
+ AnyTrackerParcel = Annotated[
20
+ Union[Tracker, TrackerIPv6, TrackerGroup, TrackerGroupIPv6],
21
+ Field(discriminator="type_"),
22
+ ]
23
+ __all__ = [
24
+ "Tracker",
25
+ "TrackerIPv6",
26
+ "EndpointTcpUdp",
27
+ "EndpointTrackerType",
28
+ "TrackerGroup",
29
+ "TrackerGroupIPv6",
30
+ "TrackerRefs",
31
+ "AnyTrackerParcel",
32
+ ]
33
+
34
+
35
+ def __dir__() -> "List[str]":
36
+ return list(__all__)
@@ -0,0 +1,96 @@
1
+ # Copyright 2025 Cisco Systems, Inc. and its affiliates
2
+ from typing import Literal, Optional, Union
3
+
4
+ from pydantic import AliasPath, BaseModel, ConfigDict, Field
5
+
6
+ from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
7
+
8
+ Protocol = Literal[
9
+ "tcp",
10
+ "udp",
11
+ ]
12
+
13
+
14
+ class EndpointTcpUdp(BaseModel):
15
+ port: Optional[Union[Variable, Global[int]]] = Field(default=None)
16
+ protocol: Optional[Union[Variable, Global[Protocol]]] = Field(default=None)
17
+
18
+
19
+ EndpointTrackerType = Literal[
20
+ "ipv6-interface",
21
+ "ipv6-interface-icmp",
22
+ ]
23
+
24
+
25
+ class Tracker(_ParcelBase):
26
+ model_config = ConfigDict(
27
+ extra="forbid",
28
+ populate_by_name=True,
29
+ )
30
+ type_: Literal["tracker"] = Field(default="tracker", exclude=True, frozen=True)
31
+ tracker_name: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "trackerName"))
32
+ tracker_type: Union[Default[Literal["endpoint"]], Variable, Global[Literal["endpoint"]]] = Field(
33
+ default=Default[Literal["endpoint"]](value="endpoint"), validation_alias=AliasPath("data", "trackerType")
34
+ )
35
+ endpoint_api_url: Optional[Union[Variable, Global[str]]] = Field(
36
+ default=None, validation_alias=AliasPath("data", "endpointApiUrl")
37
+ )
38
+ endpoint_dns_name: Optional[Union[Variable, Global[str]]] = Field(
39
+ default=None, validation_alias=AliasPath("data", "endpointDnsName")
40
+ )
41
+ endpoint_ip: Optional[Union[Variable, Global[str]]] = Field(
42
+ default=None, validation_alias=AliasPath("data", "endpointIp")
43
+ )
44
+ endpoint_tcp_udp: Optional[EndpointTcpUdp] = Field(
45
+ default=None, validation_alias=AliasPath("data", "endpointTcpUdp"), description="Endpoint tcp/udp"
46
+ )
47
+ endpoint_tracker_type: Optional[
48
+ Union[Variable, Default[Literal["static-route"]], Global[Literal["static-route"]]]
49
+ ] = Field(default=None, validation_alias=AliasPath("data", "endpointTrackerType"))
50
+ interval: Optional[Union[Default[int], Variable, Global[int]]] = Field(
51
+ default=None, validation_alias=AliasPath("data", "interval")
52
+ )
53
+ multiplier: Optional[Union[Default[int], Variable, Global[int]]] = Field(
54
+ default=None, validation_alias=AliasPath("data", "multiplier")
55
+ )
56
+ threshold: Optional[Union[Default[int], Variable, Global[int]]] = Field(
57
+ default=None, validation_alias=AliasPath("data", "threshold")
58
+ )
59
+
60
+
61
+ class TrackerIPv6(_ParcelBase):
62
+ model_config = ConfigDict(
63
+ extra="forbid",
64
+ populate_by_name=True,
65
+ )
66
+ type_: Literal["ipv6-tracker"] = Field(default="ipv6-tracker", exclude=True, frozen=True)
67
+ endpoint_api_url: Optional[Union[Variable, Global[str]]] = Field(
68
+ default=None, validation_alias=AliasPath("data", "endpointApiUrl")
69
+ )
70
+ endpoint_dns_name: Optional[Union[Variable, Global[str]]] = Field(
71
+ default=None, validation_alias=AliasPath("data", "endpointDnsName")
72
+ )
73
+ endpoint_ip: Optional[Union[Variable, Global[str]]] = Field(
74
+ default=None, validation_alias=AliasPath("data", "endpointIp")
75
+ )
76
+ endpoint_tracker_type: Optional[Union[Default[Literal["ipv6-interface"]], Global[EndpointTrackerType]]] = Field(
77
+ default=None, validation_alias=AliasPath("data", "endpointTrackerType")
78
+ )
79
+ icmp_interval: Optional[Union[Default[int], Variable, Global[int]]] = Field(
80
+ default=None, validation_alias=AliasPath("data", "icmpInterval")
81
+ )
82
+ interval: Optional[Union[Default[int], Variable, Global[int]]] = Field(
83
+ default=None, validation_alias=AliasPath("data", "interval")
84
+ )
85
+ multiplier: Optional[Union[Default[int], Variable, Global[int]]] = Field(
86
+ default=None, validation_alias=AliasPath("data", "multiplier")
87
+ )
88
+ threshold: Optional[Union[Default[int], Variable, Global[int]]] = Field(
89
+ default=None, validation_alias=AliasPath("data", "threshold")
90
+ )
91
+ tracker_name: Optional[Union[Variable, Global[str]]] = Field(
92
+ default=None, validation_alias=AliasPath("data", "trackerName")
93
+ )
94
+ tracker_type: Optional[Union[Default[Literal["endpoint"]], Variable, Global[Literal["endpoint"]]]] = Field(
95
+ default=None, validation_alias=AliasPath("data", "trackerType")
96
+ )