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,1057 @@
1
+ # Copyright 2024 Cisco Systems, Inc. and its affiliates
2
+ from ipaddress import IPv4Address, IPv4Network, IPv6Address, IPv6Network
3
+ from typing import Any, Dict, List, Literal, Optional, Tuple, Type, TypeVar, Union, overload
4
+ from uuid import UUID
5
+
6
+ from pydantic import (
7
+ AliasPath,
8
+ BaseModel,
9
+ ConfigDict,
10
+ Field,
11
+ SerializationInfo,
12
+ SerializerFunctionWrapHandler,
13
+ field_validator,
14
+ model_serializer,
15
+ )
16
+ from typing_extensions import Annotated
17
+
18
+ from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_global, as_optional_global
19
+ from catalystwan.models.common import (
20
+ AcceptDropActionType,
21
+ DestinationRegion,
22
+ DNSEntryType,
23
+ EncapType,
24
+ Icmp6MsgType,
25
+ IcmpMsgType,
26
+ SequenceIpType,
27
+ ServiceAreaValue,
28
+ ServiceChainNumber,
29
+ ServiceType,
30
+ TLOCColor,
31
+ TrafficCategory,
32
+ TrafficTargetType,
33
+ VersionedField,
34
+ )
35
+ from catalystwan.models.configuration.feature_profile.common import RefIdItem
36
+ from catalystwan.models.policy.policy_definition import DNSTypeEntryType, LossProtectionType
37
+
38
+ TrafficPolicyDirection = Literal[
39
+ "service",
40
+ "tunnel",
41
+ "all",
42
+ ]
43
+
44
+
45
+ class TrafficPolicyTarget(BaseModel):
46
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
47
+ direction: Global[TrafficPolicyDirection]
48
+ vpn: Global[List[str]]
49
+
50
+
51
+ TrafficClass = Literal[
52
+ "bronze",
53
+ "gold-broadcast-video",
54
+ "gold-bulk-data",
55
+ "gold-multimedia-conferencing",
56
+ "gold-multimedia-streaming",
57
+ "gold-network-control",
58
+ "gold-ops-admin-mgmt",
59
+ "gold-real-time-interactive",
60
+ "gold-signaling",
61
+ "gold-transactional-data",
62
+ "gold-voip-telephony",
63
+ "silver",
64
+ ]
65
+
66
+
67
+ class AppListMatch(BaseModel):
68
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
69
+ app_list: RefIdItem = Field(validation_alias="appList", serialization_alias="appList")
70
+
71
+
72
+ class SaasAppListMatch(BaseModel):
73
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
74
+ saas_app_list: RefIdItem = Field(validation_alias="saasAppList", serialization_alias="saasAppList")
75
+
76
+
77
+ class ServiceAreaMatch(BaseModel):
78
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
79
+ service_area: Global[List[ServiceAreaValue]] = Field(
80
+ validation_alias="serviceArea", serialization_alias="serviceArea"
81
+ )
82
+
83
+
84
+ class TrafficCategoryMatch(BaseModel):
85
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
86
+ traffic_category: Global[TrafficCategory] = Field(
87
+ validation_alias="trafficCategory", serialization_alias="trafficCategory"
88
+ )
89
+
90
+
91
+ class DnsAppListMatch(BaseModel):
92
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
93
+ dns_app_list: RefIdItem = Field(validation_alias="dnsAppList", serialization_alias="dnsAppList")
94
+
95
+
96
+ class TrafficClassMatch(BaseModel):
97
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
98
+ traffic_class: Global[TrafficClass] = Field(validation_alias="trafficClass", serialization_alias="trafficClass")
99
+
100
+
101
+ class DscpMatch(BaseModel):
102
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
103
+ dscp: Union[Global[int], Global[List[int]]]
104
+
105
+
106
+ class PacketLengthMatch(BaseModel):
107
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
108
+ packet_length: Global[str] = Field(validation_alias="packetLength", serialization_alias="packetLength")
109
+
110
+
111
+ class ProtocolMatch(BaseModel):
112
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
113
+ protocol: Global[List[str]]
114
+
115
+
116
+ class IcmpMessageMatch(BaseModel):
117
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
118
+ icmp_message: Global[List[IcmpMsgType]] = Field(validation_alias="icmpMessage", serialization_alias="icmpMessage")
119
+
120
+
121
+ class Icmp6MessageMatch(BaseModel):
122
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
123
+ icmp6_message: Global[List[Icmp6MsgType]] = Field(
124
+ validation_alias="icmp6Message", serialization_alias="icmp6Message"
125
+ )
126
+
127
+
128
+ class SourceDataPrefixListMatch(BaseModel):
129
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
130
+ source_data_prefix_list: RefIdItem = Field(
131
+ validation_alias="sourceDataPrefixList", serialization_alias="sourceDataPrefixList"
132
+ )
133
+
134
+
135
+ class SourceDataIpv6PrefixListMatch(BaseModel):
136
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
137
+ source_data_ipv6_prefix_list: RefIdItem = Field(
138
+ validation_alias="sourceDataIpv6PrefixList", serialization_alias="sourceDataIpv6PrefixList"
139
+ )
140
+
141
+
142
+ class SourceIpMatch(BaseModel):
143
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
144
+ source_ip: Global[IPv4Network] = Field(validation_alias="sourceIp", serialization_alias="sourceIp")
145
+
146
+
147
+ class SourceIpv6Match(BaseModel):
148
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
149
+ source_ipv6: Global[IPv6Network] = Field(validation_alias="sourceIpv6", serialization_alias="sourceIpv6")
150
+
151
+
152
+ class SourcePortMatch(BaseModel):
153
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
154
+ source_port: Global[List[str]] = Field(validation_alias="sourcePort", serialization_alias="sourcePort")
155
+
156
+
157
+ class DestinationDataPrefixListMatch(BaseModel):
158
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
159
+ destination_data_prefix_list: RefIdItem = Field(
160
+ validation_alias="destinationDataPrefixList", serialization_alias="destinationDataPrefixList"
161
+ )
162
+
163
+
164
+ class DestinationDataIpv6PrefixListMatch(BaseModel):
165
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
166
+ destination_data_ipv6_prefix_list: RefIdItem = Field(
167
+ validation_alias="destinationDataIpv6PrefixList",
168
+ serialization_alias="destinationDataIpv6PrefixList",
169
+ )
170
+
171
+
172
+ class DestinationIpMatch(BaseModel):
173
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
174
+ destination_ip: Global[IPv4Network] = Field(validation_alias="destinationIp", serialization_alias="destinationIp")
175
+
176
+
177
+ class DestinationIpv6Match(BaseModel):
178
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
179
+ destination_ipv6: Global[IPv6Network] = Field(
180
+ validation_alias="destinationIpv6", serialization_alias="destinationIpv6"
181
+ )
182
+
183
+
184
+ class DestinationPortMatch(BaseModel):
185
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
186
+ destination_port: Global[List[str]] = Field(
187
+ validation_alias="destinationPort", serialization_alias="destinationPort"
188
+ )
189
+
190
+
191
+ class TcpMatch(BaseModel):
192
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
193
+ tcp: Global[Literal["syn"]] = Field(default=Global[Literal["syn"]](value="syn"))
194
+
195
+
196
+ class DestinationRegionMatch(BaseModel):
197
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
198
+ destination_region: Global[DestinationRegion] = Field(
199
+ validation_alias="destinationRegion", serialization_alias="destinationRegion"
200
+ )
201
+
202
+
203
+ class TrafficToMatch(BaseModel):
204
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
205
+ traffic_to: Global[TrafficTargetType] = Field(validation_alias="trafficTo", serialization_alias="trafficTo")
206
+
207
+
208
+ class DnsMatch(BaseModel):
209
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
210
+ dns: Global[DNSEntryType]
211
+
212
+
213
+ Entry = Union[
214
+ AppListMatch,
215
+ SaasAppListMatch,
216
+ ServiceAreaMatch,
217
+ TrafficCategoryMatch,
218
+ DnsAppListMatch,
219
+ TrafficClassMatch,
220
+ DscpMatch,
221
+ PacketLengthMatch,
222
+ ProtocolMatch,
223
+ IcmpMessageMatch,
224
+ Icmp6MessageMatch,
225
+ SourceDataPrefixListMatch,
226
+ SourceDataIpv6PrefixListMatch,
227
+ SourceIpMatch,
228
+ SourceIpv6Match,
229
+ SourcePortMatch,
230
+ DestinationDataPrefixListMatch,
231
+ DestinationDataIpv6PrefixListMatch,
232
+ DestinationIpMatch,
233
+ DestinationIpv6Match,
234
+ DestinationPortMatch,
235
+ TcpMatch,
236
+ DestinationRegionMatch,
237
+ TrafficToMatch,
238
+ DnsMatch,
239
+ ]
240
+
241
+
242
+ class Match(BaseModel):
243
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
244
+ entries: List[Entry]
245
+
246
+
247
+ class SlaClass(BaseModel):
248
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
249
+ fallback_to_best_path: Optional[Global[bool]] = Field(
250
+ default=None, validation_alias="fallbackToBestPath", serialization_alias="fallbackToBestPath"
251
+ )
252
+ preferred_color: Optional[Global[List[TLOCColor]]] = Field(
253
+ default=None, validation_alias="preferredColor", serialization_alias="preferredColor"
254
+ )
255
+ preferred_color_group: Optional[RefIdItem] = Field(
256
+ default=None, validation_alias="preferredColorGroup", serialization_alias="preferredColorGroup"
257
+ )
258
+ preferred_remote_color: Optional[Global[List[TLOCColor]]] = Field(
259
+ default=None, validation_alias="preferredRemoteColor", serialization_alias="preferredRemoteColor"
260
+ )
261
+ remote_color_restrict: Optional[Global[bool]] = Field(
262
+ default=None, validation_alias="remoteColorRestrict", serialization_alias="remoteColorRestrict"
263
+ )
264
+ sla_name: Optional[RefIdItem] = Field(default=None, validation_alias="slaName", serialization_alias="slaName")
265
+ strict: Optional[Global[bool]] = Field(default=None)
266
+
267
+
268
+ class LocalTlocList(BaseModel):
269
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
270
+ color: Global[List[TLOCColor]]
271
+ encap: Optional[Union[Global[EncapType], Global[List[EncapType]]]] = Field(
272
+ default=None, description="encap is list <=20.12"
273
+ )
274
+ restrict: Optional[Global[bool]] = Field(default=None)
275
+
276
+ def make_encap_list(self):
277
+ if self.encap is not None and self.encap.value is not None and not isinstance(self.encap.value, List):
278
+ self.encap = Global[List[EncapType]](value=[self.encap.value])
279
+
280
+
281
+ class PreferredRemoteColor(BaseModel):
282
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
283
+ color: Global[List[TLOCColor]]
284
+ remote_color_restrict: Optional[Global[Global[bool]]] = Field(
285
+ default=None, validation_alias="remoteColorRestrict", serialization_alias="remoteColorRestrict"
286
+ )
287
+
288
+
289
+ class Tloc(BaseModel):
290
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
291
+ color: Global[List[TLOCColor]]
292
+ encap: Global[EncapType]
293
+ ip: Global[IPv4Address]
294
+
295
+
296
+ class ServiceTloc(BaseModel):
297
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
298
+ tloc: Tloc = Field()
299
+ type: Global[ServiceType]
300
+ vpn: Global[int]
301
+
302
+
303
+ class ServiceTlocList(BaseModel):
304
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
305
+ tloc_list: Optional[RefIdItem] = Field(default=None, validation_alias="tlocList", serialization_alias="tlocList")
306
+ type: Optional[Global[ServiceType]] = Field(default=None)
307
+ vpn: Optional[Global[int]] = Field(default=None)
308
+
309
+
310
+ class ServiceChain(BaseModel):
311
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
312
+ local: Global[bool]
313
+ restrict: Global[bool]
314
+ tloc: Optional[Tloc] = Field(default=None)
315
+ tloc_list: Optional[RefIdItem] = Field(default=None, validation_alias="tlocList", serialization_alias="tlocList")
316
+ type: Global[ServiceChainNumber]
317
+ vpn: Optional[Global[int]] = Field(default=None)
318
+
319
+
320
+ class SetDscp(BaseModel):
321
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
322
+ dscp: Optional[Global[int]] = Field(default=None)
323
+
324
+
325
+ class SetForwardingClass(BaseModel):
326
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
327
+ forwarding_class: Optional[RefIdItem] = Field(
328
+ default=None, validation_alias="forwardingClass", serialization_alias="forwardingClass"
329
+ )
330
+
331
+
332
+ class SetLocalTlocList(BaseModel):
333
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
334
+ local_tloc_list: Optional[LocalTlocList] = Field(
335
+ default=None, validation_alias="localTlocList", serialization_alias="localTlocList"
336
+ )
337
+
338
+ def make_encap_list(self):
339
+ if self.local_tloc_list is not None:
340
+ self.local_tloc_list.make_encap_list()
341
+
342
+
343
+ class SetNextHop(BaseModel):
344
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
345
+ next_hop: Optional[Global[IPv4Address]] = Field(
346
+ default=None, validation_alias="nextHop", serialization_alias="nextHop"
347
+ )
348
+
349
+
350
+ class SetNextHopIpv6(BaseModel):
351
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
352
+ next_hop_ipv6: Optional[Global[IPv6Address]] = Field(
353
+ default=None, validation_alias="nextHopIpv6", serialization_alias="nextHopIpv6"
354
+ )
355
+
356
+
357
+ class SetNextHopLoose(BaseModel):
358
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
359
+ next_hop_loose: Optional[Global[bool]] = Field(
360
+ default=None, validation_alias="nextHopLoose", serialization_alias="nextHopLoose"
361
+ )
362
+
363
+
364
+ class SetPolicer(BaseModel):
365
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
366
+ policer: Optional[RefIdItem] = Field(default=None)
367
+
368
+
369
+ class SetPreferredColorGroup(BaseModel):
370
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
371
+ preferred_color_group: Optional[RefIdItem] = Field(
372
+ default=None, validation_alias="preferredColorGroup", serialization_alias="preferredColorGroup"
373
+ )
374
+
375
+
376
+ class SetPreferredRemoteColor(BaseModel):
377
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
378
+ preferred_remote_color: Optional[PreferredRemoteColor] = Field(
379
+ default=None, validation_alias="preferredRemoteColor", serialization_alias="preferredRemoteColor"
380
+ )
381
+
382
+
383
+ class SetService(BaseModel):
384
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
385
+ service: Optional[Union[ServiceTloc, ServiceTlocList]] = Field(default=None)
386
+
387
+
388
+ class SetServiceChain(BaseModel):
389
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
390
+ service_chain: Annotated[Optional[ServiceChain], VersionedField(versions="<20.15", forbidden=True)] = Field(
391
+ default=None, validation_alias="serviceChain", serialization_alias="serviceChain"
392
+ )
393
+
394
+
395
+ class SetTloc(BaseModel):
396
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
397
+ tloc: Optional[Tloc] = Field(default=None)
398
+
399
+
400
+ class SetTlocList(BaseModel):
401
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
402
+ tloc_list: Optional[RefIdItem] = Field(default=None, validation_alias="tlocList", serialization_alias="tlocList")
403
+
404
+
405
+ class SetVpn(BaseModel):
406
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
407
+ vpn: Optional[Global[int]] = Field(default=None)
408
+
409
+
410
+ Set = Union[
411
+ SetDscp,
412
+ SetForwardingClass,
413
+ SetLocalTlocList,
414
+ SetNextHop,
415
+ SetNextHopIpv6,
416
+ SetNextHopLoose,
417
+ SetPolicer,
418
+ SetPreferredColorGroup,
419
+ SetPreferredRemoteColor,
420
+ SetService,
421
+ SetServiceChain,
422
+ SetTloc,
423
+ SetTlocList,
424
+ SetVpn,
425
+ ]
426
+
427
+ RedirectDnsType = Literal[
428
+ "dnsHost",
429
+ "ipAddress",
430
+ ]
431
+
432
+
433
+ class RedirectDns(BaseModel):
434
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
435
+ field: Optional[Global[RedirectDnsType]] = Field(default=None)
436
+ value: Optional[Union[Global[DNSTypeEntryType], Global[IPv4Address]]] = Field(default=None)
437
+
438
+ @staticmethod
439
+ def from_ip(ip: IPv4Address) -> "RedirectDns":
440
+ return RedirectDns(field=as_global("ipAddress", RedirectDnsType), value=as_global(ip))
441
+
442
+ @staticmethod
443
+ def from_dns_type(dns: DNSTypeEntryType) -> "RedirectDns":
444
+ return RedirectDns(field=as_global("dnsHost", RedirectDnsType), value=as_global(dns, DNSTypeEntryType))
445
+
446
+
447
+ class AppqoeOptimization(BaseModel):
448
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
449
+ dre_optimization: Optional[Global[bool]] = Field(
450
+ default=None, validation_alias="dreOptimization", serialization_alias="dreOptimization"
451
+ )
452
+ service_node_group: Global[str] = Field(validation_alias="serviceNodeGroup", serialization_alias="serviceNodeGroup")
453
+ tcp_optimization: Optional[Global[bool]] = Field(
454
+ default=None, validation_alias="tcpOptimization", serialization_alias="tcpOptimization"
455
+ )
456
+
457
+ @field_validator("service_node_group")
458
+ @classmethod
459
+ def check_service_node_group(cls, service_node_group: Global[str]):
460
+ assert service_node_group.value.startswith("SNG-APPQOE")
461
+ return service_node_group
462
+
463
+
464
+ class LossCorrection(BaseModel):
465
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
466
+ loss_correct_fec: Optional[Global[int]] = Field(
467
+ default=None, validation_alias="lossCorrectFec", serialization_alias="lossCorrectFec"
468
+ )
469
+ loss_correction_type: Global[LossProtectionType] = Field(
470
+ validation_alias="lossCorrectionType", serialization_alias="lossCorrectionType"
471
+ )
472
+
473
+
474
+ class Nat(BaseModel):
475
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
476
+ bypass: Annotated[Optional[Global[bool]], VersionedField(versions="<20.14", forbidden=True)] = Field(default=None)
477
+ dia_interface: Annotated[Optional[Global[List[str]]], VersionedField(versions="<20.14", forbidden=True)] = Field(
478
+ default=None, validation_alias="diaInterface", serialization_alias="diaInterface"
479
+ )
480
+ dia_pool: Annotated[Optional[Global[List[int]]], VersionedField(versions="<20.14", forbidden=True)] = Field(
481
+ default=None, validation_alias="diaPool", serialization_alias="diaPool"
482
+ )
483
+ fallback: Optional[Global[bool]] = Field(default=None)
484
+ use_vpn: Global[bool] = Field(validation_alias="useVpn", serialization_alias="useVpn")
485
+
486
+ @model_serializer(mode="wrap", when_used="json")
487
+ def serialize(self, handler: SerializerFunctionWrapHandler, info: SerializationInfo) -> Dict[str, Any]:
488
+ return VersionedField.dump(self.model_fields, handler(self), info)
489
+
490
+
491
+ SecureServiceEdgeInstance = Literal[
492
+ "Cisco-Secure-Access",
493
+ "zScaler",
494
+ ]
495
+
496
+
497
+ class Sse(BaseModel):
498
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
499
+ secure_service_edge: Global[Global[bool]] = Field(
500
+ validation_alias="secureServiceEdge", serialization_alias="secureServiceEdge"
501
+ )
502
+ secure_service_edge_instance: Global[SecureServiceEdgeInstance] = Field(
503
+ validation_alias="secureServiceEdgeInstance", serialization_alias="secureServiceEdgeInstance"
504
+ )
505
+
506
+
507
+ class SlaClassAction(BaseModel):
508
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
509
+ sla_class: Optional[List[SlaClass]] = Field(
510
+ default=None, validation_alias="slaClass", serialization_alias="slaClass", description="slaClass"
511
+ )
512
+
513
+ @staticmethod
514
+ def from_params(
515
+ sla_name: Optional[UUID] = None,
516
+ preferred_color: Optional[List[TLOCColor]] = None,
517
+ preferred_color_group: Optional[UUID] = None,
518
+ preferred_remote_color: Optional[List[TLOCColor]] = None,
519
+ remote_color_restrict: Optional[bool] = None,
520
+ strict: Optional[bool] = None,
521
+ fallback_to_best_path: Optional[bool] = None,
522
+ ) -> "SlaClassAction":
523
+ action = SlaClassAction()
524
+ action.sla_class = []
525
+ if sla_name:
526
+ action.sla_class.append(SlaClass(sla_name=RefIdItem.from_uuid(sla_name)))
527
+ if preferred_color:
528
+ action.sla_class.append(SlaClass(preferred_color=Global[List[TLOCColor]](value=preferred_color)))
529
+ if preferred_color_group:
530
+ action.sla_class.append(SlaClass(preferred_color_group=RefIdItem.from_uuid(preferred_color_group)))
531
+ if preferred_remote_color:
532
+ action.sla_class.append(
533
+ SlaClass(preferred_remote_color=Global[List[TLOCColor]](value=preferred_remote_color))
534
+ )
535
+ if remote_color_restrict is not None:
536
+ action.sla_class.append(SlaClass(remote_color_restrict=Global[bool](value=remote_color_restrict)))
537
+ if strict is not None:
538
+ action.sla_class.append(SlaClass(strict=Global[bool](value=strict)))
539
+ if fallback_to_best_path is not None:
540
+ action.sla_class.append(SlaClass(fallback_to_best_path=Global[bool](value=fallback_to_best_path)))
541
+ return action
542
+
543
+
544
+ class BackupSlaPreferredColorAction(BaseModel):
545
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
546
+ backup_sla_preferred_color: Global[List[TLOCColor]] = Field(
547
+ validation_alias="backupSlaPreferredColor", serialization_alias="backupSlaPreferredColor"
548
+ )
549
+
550
+
551
+ TS = TypeVar("TS", bound=Set)
552
+
553
+
554
+ class SetAction(BaseModel):
555
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
556
+ set: List[Set] = Field(default_factory=list)
557
+
558
+ @property
559
+ def _set(self):
560
+ if self.set is None:
561
+ self.set = []
562
+ return self.set
563
+
564
+ def _find_action_with_index(self, action_type: Type[TS]) -> Tuple[Optional[int], Optional[TS]]:
565
+ for i, action in enumerate(self._set):
566
+ if isinstance(action, action_type):
567
+ return (i, action)
568
+ return (None, None)
569
+
570
+ def find_action(self, action_type: Type[TS]) -> Optional[TS]:
571
+ _, action = self._find_action_with_index(action_type)
572
+ if action is not None:
573
+ return action
574
+ return None
575
+
576
+ def _insert_action(self, action: Set) -> None:
577
+ i, _ = self._find_action_with_index(type(action))
578
+ if i is not None:
579
+ self._set[i] = action
580
+ else:
581
+ self._set.append(action)
582
+
583
+
584
+ class RedirectDnsAction(BaseModel):
585
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
586
+ redirect_dns: RedirectDns = Field(validation_alias="redirectDns", serialization_alias="redirectDns")
587
+
588
+
589
+ class AppqoeOptimizationAction(BaseModel):
590
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
591
+ appqoe_optimization: AppqoeOptimization = Field(
592
+ validation_alias="appqoeOptimization", serialization_alias="appqoeOptimization"
593
+ )
594
+
595
+
596
+ class LossCorrectionAction(BaseModel):
597
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
598
+ loss_correction: LossCorrection = Field(validation_alias="lossCorrection", serialization_alias="lossCorrection")
599
+
600
+
601
+ class CountAction(BaseModel):
602
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
603
+ count: Global[str]
604
+
605
+
606
+ class LogAction(BaseModel):
607
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
608
+ log: Global[bool]
609
+
610
+
611
+ class CloudSaasAction(BaseModel):
612
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
613
+ cloud_saas: Global[bool] = Field(validation_alias="cloudSaas", serialization_alias="cloudSaas")
614
+
615
+
616
+ class CloudProbeAction(BaseModel):
617
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
618
+ cloud_probe: Global[bool] = Field(validation_alias="cloudProbe", serialization_alias="cloudProbe")
619
+
620
+
621
+ class CflowdAction(BaseModel):
622
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
623
+ cflowd: Global[bool]
624
+
625
+
626
+ class NatPoolAction(BaseModel):
627
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
628
+ nat_pool: Global[int] = Field(validation_alias="natPool", serialization_alias="natPool")
629
+
630
+
631
+ class NatAction(BaseModel):
632
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
633
+ nat: Nat
634
+
635
+
636
+ class SigAction(BaseModel):
637
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
638
+ sig: Global[bool]
639
+
640
+
641
+ class FallbackToRoutingAction(BaseModel):
642
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
643
+ fallback_to_routing: Global[bool] = Field(
644
+ validation_alias="fallbackToRouting", serialization_alias="fallbackToRouting"
645
+ )
646
+
647
+
648
+ class SseAction(BaseModel):
649
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
650
+ sse: Sse
651
+
652
+
653
+ Action = Union[
654
+ AppqoeOptimizationAction,
655
+ BackupSlaPreferredColorAction,
656
+ CflowdAction,
657
+ CloudProbeAction,
658
+ CloudSaasAction,
659
+ CountAction,
660
+ FallbackToRoutingAction,
661
+ LogAction,
662
+ LossCorrectionAction,
663
+ NatAction,
664
+ NatPoolAction,
665
+ RedirectDnsAction,
666
+ SetAction,
667
+ SigAction,
668
+ SlaClassAction,
669
+ SseAction,
670
+ ]
671
+
672
+ TA = TypeVar("TA", bound=Action)
673
+ TM = TypeVar("TM", bound=Entry)
674
+
675
+
676
+ class Sequence(BaseModel):
677
+ model_config = ConfigDict(populate_by_name=True, extra="forbid")
678
+ actions: Optional[List[Action]] = Field(default=None)
679
+ base_action: Optional[Global[AcceptDropActionType]] = Field(
680
+ default=None, validation_alias="baseAction", serialization_alias="baseAction"
681
+ )
682
+ match: Optional[Match] = Field(default=None)
683
+ sequence_id: Optional[Global[int]] = Field(
684
+ default=None, validation_alias="sequenceId", serialization_alias="sequenceId"
685
+ )
686
+ sequence_ip_type: Global[SequenceIpType] = Field(
687
+ validation_alias="sequenceIpType", serialization_alias="sequenceIpType"
688
+ )
689
+ sequence_name: Optional[Global[str]] = Field(
690
+ default=None, validation_alias="sequenceName", serialization_alias="sequenceName"
691
+ )
692
+
693
+ def _obtain_match(self) -> Match:
694
+ if self.match is None:
695
+ self.match = Match(entries=[])
696
+ if self.match.entries is None:
697
+ self.match.entries = []
698
+ return self.match
699
+
700
+ def _match(self, entry: Entry):
701
+ self._obtain_match().entries.append(entry)
702
+
703
+ def find_match_entry(self, entry_type: Type[TM]) -> Optional[TM]:
704
+ entries = self._obtain_match().entries
705
+ for entry in entries:
706
+ if isinstance(entry, type(entry_type)):
707
+ return entry
708
+ return None
709
+
710
+ @property
711
+ def _actions(self) -> List[Action]:
712
+ if self.actions is None:
713
+ self.actions = []
714
+ return self.actions
715
+
716
+ def _find_action_with_index(self, action_type: Type[TA]) -> Tuple[Optional[int], Optional[TA]]:
717
+ for i, action in enumerate(self._actions):
718
+ if isinstance(action, action_type):
719
+ return (i, action)
720
+ return (None, None)
721
+
722
+ def find_action(self, action_type: Type[TA]) -> Optional[TA]:
723
+ _, action = self._find_action_with_index(action_type)
724
+ if action is not None:
725
+ return action
726
+ return None
727
+
728
+ def _insert_action(self, action: Action) -> None:
729
+ i, _ = self._find_action_with_index(type(action))
730
+ if i is not None:
731
+ self._actions[i] = action
732
+ else:
733
+ self._actions.append(action)
734
+
735
+ @property
736
+ def _action_set(self) -> SetAction:
737
+ ac_set = self.find_action(SetAction)
738
+ if ac_set is None:
739
+ ac_set = SetAction()
740
+ self._actions.append(ac_set)
741
+ return ac_set
742
+
743
+ def _insert_action_in_set(self, action: Set) -> None:
744
+ self._action_set._insert_action(action)
745
+
746
+ def match_app_list(self, list_id: UUID):
747
+ entry = AppListMatch(app_list=RefIdItem(ref_id=as_global(str(list_id))))
748
+ self._match(entry)
749
+
750
+ def match_saas_app_list(self, list_id: UUID):
751
+ entry = SaasAppListMatch(saas_app_list=RefIdItem(ref_id=as_global(str(list_id))))
752
+ self._match(entry)
753
+
754
+ def match_service_areas(self, service_areas: List[ServiceAreaValue]):
755
+ entry = ServiceAreaMatch(service_area=Global[List[ServiceAreaValue]](value=service_areas))
756
+ self._match(entry)
757
+
758
+ def match_traffic_category(self, traffic_category: TrafficCategory):
759
+ entry = TrafficCategoryMatch(traffic_category=as_global(traffic_category, TrafficCategory))
760
+ self._match(entry)
761
+
762
+ def match_dns_app_list(self, list_id: UUID):
763
+ entry = DnsAppListMatch(dns_app_list=RefIdItem(ref_id=as_global(str(list_id))))
764
+ self._match(entry)
765
+
766
+ def match_traffic_class(self, traffic_class: TrafficClass):
767
+ entry = TrafficClassMatch(traffic_class=as_global(traffic_class, TrafficClass))
768
+ self._match(entry)
769
+
770
+ def match_dscp(self, dscp: List[int]):
771
+ if len(dscp) == 1:
772
+ entry = DscpMatch(dscp=Global[int](value=dscp[0]))
773
+ else:
774
+ entry = DscpMatch(dscp=Global[List[int]](value=dscp))
775
+ self._match(entry)
776
+
777
+ def match_packet_length(self, packet_length: str):
778
+ entry = PacketLengthMatch(packet_length=as_global(packet_length))
779
+ self._match(entry)
780
+
781
+ def match_protocols(self, protocols: List[str]):
782
+ entry = ProtocolMatch(protocol=Global[List[str]](value=protocols))
783
+ self._match(entry)
784
+
785
+ def match_icmp_messages(self, messages: List[IcmpMsgType]):
786
+ entry = IcmpMessageMatch(icmp_message=Global[List[IcmpMsgType]](value=messages))
787
+ self._match(entry)
788
+
789
+ def match_icmp6_message(self, messages: List[Icmp6MsgType]):
790
+ entry = Icmp6MessageMatch(icmp6_message=Global[List[Icmp6MsgType]](value=messages))
791
+ self._match(entry)
792
+
793
+ def match_source_data_prefix_list(self, list_id: UUID):
794
+ entry = SourceDataPrefixListMatch(source_data_prefix_list=RefIdItem(ref_id=as_global(str(list_id))))
795
+ self._match(entry)
796
+
797
+ def match_source_data_ipv6_prefix_list(self, list_id: UUID):
798
+ entry = SourceDataIpv6PrefixListMatch(source_data_ipv6_prefix_list=RefIdItem(ref_id=as_global(str(list_id))))
799
+ self._match(entry)
800
+
801
+ def match_source_ip(self, ipv4_network: IPv4Network):
802
+ entry = SourceIpMatch(source_ip=as_global(ipv4_network))
803
+ self._match(entry)
804
+
805
+ def match_source_ipv6(self, ipv6_network: IPv6Network):
806
+ entry = SourceIpv6Match(source_ipv6=as_global(ipv6_network))
807
+ self._match(entry)
808
+
809
+ def match_source_ports(self, source_ports: List[str]):
810
+ entry = SourcePortMatch(source_port=Global[List[str]](value=source_ports))
811
+ self._match(entry)
812
+
813
+ def match_destination_data_prefix_list(self, list_id: UUID):
814
+ entry = DestinationDataPrefixListMatch(destination_data_prefix_list=RefIdItem(ref_id=as_global(str(list_id))))
815
+ self._match(entry)
816
+
817
+ def match_destination_data_ipv6_prefix_list(self, list_id: UUID):
818
+ entry = DestinationDataIpv6PrefixListMatch(
819
+ destination_data_ipv6_prefix_list=RefIdItem(ref_id=as_global(str(list_id)))
820
+ )
821
+ self._match(entry)
822
+
823
+ def match_destination_ip(self, ipv4_network: IPv4Network):
824
+ entry = DestinationIpMatch(destination_ip=as_global(ipv4_network))
825
+ self._match(entry)
826
+
827
+ def match_destination_ipv6(self, ipv6_network: IPv6Network):
828
+ entry = DestinationIpv6Match(destination_ipv6=as_global(ipv6_network))
829
+ self._match(entry)
830
+
831
+ def match_destination_ports(self, destination_ports: List[str]):
832
+ entry = DestinationPortMatch(destination_port=Global[List[str]](value=destination_ports))
833
+ self._match(entry)
834
+
835
+ def match_tcp(self):
836
+ entry = TcpMatch()
837
+ self._match(entry)
838
+
839
+ def match_destination_region(self, destination_region: DestinationRegion):
840
+ entry = DestinationRegionMatch(destination_region=as_global(destination_region, DestinationRegion))
841
+ self._match(entry)
842
+
843
+ def match_traffic_to(self, traffic_target: TrafficTargetType):
844
+ entry = TrafficToMatch(traffic_to=as_global(traffic_target, TrafficTargetType))
845
+ self._match(entry)
846
+
847
+ def match_dns(self, dns: DNSEntryType):
848
+ entry = DnsMatch(dns=as_global(dns, DNSEntryType))
849
+ self._match(entry)
850
+
851
+ # --- Actions: Set ----
852
+ def associate_dscp_action(self, dscp: int) -> None:
853
+ self._insert_action_in_set(SetDscp(dscp=as_global(dscp)))
854
+
855
+ def associate_forwarding_class_action(self, fwclass_id: UUID) -> None:
856
+ fwclass = SetForwardingClass(forwarding_class=RefIdItem.from_uuid(fwclass_id))
857
+ self._insert_action_in_set(fwclass)
858
+
859
+ def associate_local_tloc_list_action(
860
+ self, color: List[TLOCColor], encap: Optional[EncapType] = None, restrict: bool = False
861
+ ) -> SetLocalTlocList:
862
+ tloc_list = LocalTlocList(
863
+ color=Global[List[TLOCColor]](value=color),
864
+ encap=as_optional_global(encap, EncapType),
865
+ restrict=as_global(restrict),
866
+ )
867
+ set_local_tloc_list = SetLocalTlocList(local_tloc_list=tloc_list)
868
+ self._insert_action_in_set(set_local_tloc_list)
869
+ return set_local_tloc_list
870
+
871
+ def associate_next_hop_action(self, ip: IPv4Address) -> None:
872
+ self._insert_action_in_set(SetNextHop(next_hop=as_global(ip)))
873
+
874
+ def associate_next_hop_ipv6_action(self, ip: IPv6Address) -> None:
875
+ self._insert_action_in_set(SetNextHopIpv6(next_hop_ipv6=as_global(ip)))
876
+
877
+ def associate_next_hop_loose_action(self, value: bool = True) -> None:
878
+ self._insert_action_in_set(SetNextHopLoose(next_hop_loose=as_global(value)))
879
+
880
+ def associate_policer_action(self, policer: UUID) -> None:
881
+ self._insert_action_in_set(SetPolicer(policer=RefIdItem.from_uuid(policer)))
882
+
883
+ def associate_preferred_color_group_action(self, group_id: UUID) -> None:
884
+ self._insert_action_in_set(SetPreferredColorGroup(preferred_color_group=RefIdItem.from_uuid(group_id)))
885
+
886
+ def associate_preferred_remote_color_action(self) -> None:
887
+ pass
888
+
889
+ @overload
890
+ def associate_service_action(
891
+ self, service_type: ServiceType, vpn: Optional[int] = None, *, tloc_list_id: UUID
892
+ ) -> None:
893
+ ...
894
+
895
+ @overload
896
+ def associate_service_action(
897
+ self, service_type: ServiceType, vpn: int, *, ip: IPv4Address, color: List[TLOCColor], encap: EncapType
898
+ ) -> None:
899
+ ...
900
+
901
+ def associate_service_action(
902
+ self,
903
+ service_type=None,
904
+ vpn=None,
905
+ *,
906
+ tloc_list_id=None,
907
+ ip=None,
908
+ color=None,
909
+ encap=None,
910
+ ) -> None:
911
+ _service_type = as_global(service_type, ServiceType)
912
+ _vpn = as_optional_global(vpn)
913
+ service: Union[ServiceTloc, ServiceTlocList]
914
+ if tloc_list_id is None:
915
+ tloc = Tloc(
916
+ color=Global[List[TLOCColor]](value=color),
917
+ encap=as_global(encap, EncapType),
918
+ ip=as_global(ip),
919
+ )
920
+ service = ServiceTloc(
921
+ tloc=tloc,
922
+ type=_service_type,
923
+ vpn=_vpn,
924
+ )
925
+ else:
926
+ service = ServiceTlocList(tloc_list=RefIdItem.from_uuid(tloc_list_id), type=_service_type, vpn=_vpn)
927
+ self._insert_action_in_set(SetService(service=service))
928
+
929
+ def associate_service_chain_action(self) -> None:
930
+ pass # TODO (>=20.15)
931
+
932
+ def associate_tloc_action(self, ip: IPv4Address, color: List[TLOCColor], encap: EncapType) -> None:
933
+ tloc = Tloc(
934
+ color=Global[List[TLOCColor]](value=color),
935
+ encap=as_global(encap, EncapType),
936
+ ip=as_global(ip),
937
+ )
938
+ self._insert_action_in_set(SetTloc(tloc=tloc))
939
+
940
+ def associate_tloc_list_action(self, tloc_list_id: UUID) -> None:
941
+ self._insert_action_in_set(SetTlocList(tloc_list=RefIdItem.from_uuid(tloc_list_id)))
942
+
943
+ def associate_vpn_action(self, vpn: int) -> None:
944
+ self._insert_action_in_set(SetVpn(vpn=as_global(vpn)))
945
+
946
+ # --- Actions ----
947
+ def associate_appqoe_optimization_action(
948
+ self, dre_optimization: bool, service_node_group: str, tcp_optimization: bool
949
+ ) -> None:
950
+ appqoe_optimization = AppqoeOptimization(
951
+ dre_optimization=as_global(dre_optimization),
952
+ service_node_group=as_global(service_node_group),
953
+ tcp_optimization=as_global(tcp_optimization),
954
+ )
955
+ action = AppqoeOptimizationAction(appqoe_optimization=appqoe_optimization)
956
+ self._insert_action(action)
957
+
958
+ def associate_backup_sla_preferred_color_action(self, tloc_colors: List[TLOCColor]) -> None:
959
+ self._insert_action(
960
+ BackupSlaPreferredColorAction(backup_sla_preferred_color=Global[List[TLOCColor]](value=tloc_colors))
961
+ )
962
+
963
+ def associate_cflowd_action(self, cflowd: bool) -> None:
964
+ self._insert_action(CflowdAction(cflowd=as_global(cflowd)))
965
+
966
+ def associate_cloud_probe_action(self) -> None:
967
+ self._insert_action(CloudProbeAction(cloud_probe=as_global(True)))
968
+
969
+ def associate_cloud_saas_action(self) -> None:
970
+ self._insert_action(CloudSaasAction(cloud_saas=as_global(True)))
971
+
972
+ def associate_count_action(self, count: str) -> None:
973
+ self._insert_action(CountAction(count=as_global(count)))
974
+
975
+ def associate_fallback_to_routing_action(self) -> None:
976
+ self._insert_action(FallbackToRoutingAction(fallback_to_routing=as_global(True)))
977
+
978
+ def associate_log_action(self, log: bool) -> None:
979
+ self._insert_action(LogAction(log=as_global(log)))
980
+
981
+ def associate_loss_correction_action(self, type: LossProtectionType, fec: Optional[int] = None) -> None:
982
+ loss_correction = LossCorrection(
983
+ loss_correct_fec=as_optional_global(fec), loss_correction_type=as_global(type, LossProtectionType)
984
+ )
985
+ self._insert_action(LossCorrectionAction(loss_correction=loss_correction))
986
+
987
+ def associate_nat_action(
988
+ self, bypass: bool, dia_interface: List[str], dia_pool: List[int], fallback: Optional[bool], use_vpn: bool
989
+ ) -> None:
990
+ nat = Nat(
991
+ bypass=as_global(bypass),
992
+ dia_interface=as_global(dia_interface) if dia_interface else None,
993
+ dia_pool=as_global(dia_pool) if dia_pool else None,
994
+ fallback=as_optional_global(fallback),
995
+ use_vpn=as_global(use_vpn),
996
+ )
997
+ self._insert_action(NatAction(nat=nat))
998
+
999
+ def associate_nat_pool_action(self, nat_pool: int) -> None:
1000
+ self._insert_action(NatPoolAction(nat_pool=as_global(nat_pool)))
1001
+
1002
+ def associate_redirect_dns_action_with_ip(self, ip: IPv4Address) -> None:
1003
+ self._insert_action(RedirectDnsAction(redirect_dns=RedirectDns.from_ip(ip)))
1004
+
1005
+ def associate_redirect_dns_action_with_dns_type(self, dns: DNSTypeEntryType) -> None:
1006
+ self._insert_action(RedirectDnsAction(redirect_dns=RedirectDns.from_dns_type(dns)))
1007
+
1008
+ def associate_set_action(self) -> None:
1009
+ pass # TODO
1010
+
1011
+ def associate_sig_action(self) -> None:
1012
+ self._insert_action(SigAction(sig=as_global(True)))
1013
+
1014
+ def associate_sla_class_action(
1015
+ self,
1016
+ sla_name: Optional[UUID] = None,
1017
+ preferred_color: Optional[List[TLOCColor]] = None,
1018
+ preferred_color_group: Optional[UUID] = None,
1019
+ preferred_remote_color: Optional[List[TLOCColor]] = None,
1020
+ remote_color_restrict: Optional[bool] = None,
1021
+ strict: Optional[bool] = None,
1022
+ fallback_to_best_path: Optional[bool] = None,
1023
+ ) -> None:
1024
+ action = SlaClassAction.from_params(
1025
+ sla_name=sla_name,
1026
+ preferred_color=preferred_color,
1027
+ preferred_color_group=preferred_color_group,
1028
+ preferred_remote_color=preferred_remote_color,
1029
+ remote_color_restrict=remote_color_restrict,
1030
+ strict=strict,
1031
+ fallback_to_best_path=fallback_to_best_path,
1032
+ )
1033
+ self._insert_action(action)
1034
+
1035
+ def associate_sse_action(self) -> None:
1036
+ pass # TODO
1037
+
1038
+
1039
+ class TrafficPolicyParcel(_ParcelBase):
1040
+ type_: Literal["traffic-policy"] = Field(default="traffic-policy", exclude=True)
1041
+ data_default_action: Optional[Global[AcceptDropActionType]] = Field(
1042
+ default=None, validation_alias=AliasPath("data", "dataDefaultAction")
1043
+ )
1044
+ has_cor_via_sig: Optional[Global[bool]] = Field(default=None, validation_alias=AliasPath("data", "hasCorViaSig"))
1045
+ sequences: List[Sequence] = Field(default_factory=list, validation_alias=AliasPath("data", "sequences"))
1046
+ simple_flow: Optional[Global[bool]] = Field(default=None, validation_alias=AliasPath("data", "simpleFlow"))
1047
+ target: TrafficPolicyTarget = Field(validation_alias=AliasPath("data", "target"))
1048
+
1049
+ def add_sequence(self, name: str, id_: int, ip_type: SequenceIpType, base_action: AcceptDropActionType) -> Sequence:
1050
+ seq = Sequence(
1051
+ sequence_name=as_global(name),
1052
+ sequence_id=as_global(id_),
1053
+ sequence_ip_type=as_global(ip_type, SequenceIpType),
1054
+ base_action=as_global(base_action, AcceptDropActionType),
1055
+ )
1056
+ self.sequences.append(seq)
1057
+ return seq