0.16.0-a1 – 2024-03-06

🚀 Features

Important

✨✨Preliminary support for Orchestrator 9.3+✨✨:

There were hundreds of changes to Orchestrator API endpoints in 9.3 forward. Logic has been added to the pyedgeconnect Orchestrator class init and login functions to capture Orchestrator version information to then determine corrent endpoint syntax in further functions.

As part of this update, 280+ pyedgeconnect functions have been updated for 9.3 support, detailed in the updated and added functions section.

All the logic has been written with cross-compatability in mind so a majority of existing code using pyedgeconnect should not need to be rewritten for functions that have been written for 9.3 support.

As an example, let’s disect get_api_key()

In use, it takes the single paramter name for retrieving a particular API key from Orchestrator

orch.get_api_key(name="myKey")

The original source code for this function just had a simple path with the paramter inline.

return self._get(f"/apiKey/{name}")

The updated source code for this and other functions, leverages the Orchestrator version to determine the apporpriate syntax.

if self.orch_version >= 9.3:
    path = f"/apiKey?name={name}"
else:
    path = f"/apiKey/{name}"

return self._get(path)

• ✨ A new code example!: ⚙️ Automate configuring Service Orchestration for HPE Aruba Networking SSE including automating the location and tunnels on the SSE platform side. Read through the full writeup in the examples to kickstart your integration asap!

• ✨ A new code example!: 📈 Pull WAN interface minute data from Orchestrator to CSV files and generate a report calculating 95th percentile utilization per-appliance as well as per-interface. Written walkthrough under the examples section.

• ✨ A new code example!: 🚀 Pull Boost minute data from Orchestrator to CSV files per appliance with a simple calculation to estimate Kbps from the Bytes Boosted value in the original data to more easily compare to the configured Boost value already in Kbps. Written walkthrough under the examples section.

• Updated code example!: EdgeConnect Telemetry demo now includes parsing Shaper & Traffic class data.

Updated the following Orchestrator functions from Swagger:

Added updated API endpoint for Orchestrator 9.3+ support of the following functions, sorted below by their respective Swagger tags.

ACLS

• get_appliance_acls()

ADMIN_DISTANCE

• get_appliance_admin_distance()

AGGREGATE_STATS

• get_aggregate_stats_tunnels_ne_pk_list()

• get_aggregate_stats_tunnels_single_appliance()

• get_aggregate_stats_appliances_ne_pk_list()

• get_aggregate_stats_appliances_single_appliance()

• get_aggregate_stats_applications_ne_pk_list()

• get_aggregate_stats_applications_single_appliance()

• get_aggregate_stats_traffic_class_ne_pk_list()

• get_aggregate_stats_traffic_class_single_appliance()

• get_aggregate_stats_flows_ne_pk_list()

• get_aggregate_stats_active_flows()

• get_aggregate_stats_flows_single_appliance()

• get_aggregate_stats_dscp_ne_pk_list()

• get_aggregate_stats_dscp_single_appliance()

• get_aggregate_stats_dns_ne_pk_list()

• get_aggregate_stats_dns_single_appliance()

• get_aggregate_stats_ports_single_appliance()

• get_aggregate_stats_ports_ne_pk_list()

• get_aggregate_stats_top_talkers_ne_pk_list()

• get_aggregate_stats_top_talkers_single_appliance()

• get_aggregate_stats_top_talkers_split_single_appliance()

• get_aggregate_stats_traffic_behavior_ne_pk_list()

• get_aggregate_stats_traffic_behavior_single_appliance()

• get_aggregate_stats_jitter_ne_pk_list()

• get_aggregate_stats_jitter_single_appliance()

• get_aggregate_stats_drc_ne_pk_list()

• get_aggregate_stats_drc_single_appliance()

• get_aggregate_stats_interface_ne_pk_list()

• get_aggregate_stats_interface_overlay_transport_ne_pk_list()

• get_aggregate_stats_mos_ne_pk_list()

• get_aggregate_stats_mos_single_appliance()

• get_aggregate_stats_boost_ne_pk_list()

• get_aggregate_stats_boost_single_appliance()

• get_aggregate_stats_security_policy_ne_pk_list()

• get_aggregate_stats_security_policy_single_appliance()

ALARM

• get_alarms_from_appliances()

• acknolwedge_alarms_from_appliance()

• add_note_to_appliance_alarm()

• clear_alarms_from_appliance()

• get_alarm_count_from_appliance()

• get_alarm_count_orchestrator_or_appliances()

• get_customized_alarm_severity()

• get_customized_alarm_severity_for_type()

• delete_customized_alarm_severity_for_type()

API_KEYS

• get_api_key()

• update_api_key()

• delete_api_key()

APPLIANCE

• get_appliances()

  • This function now has an additional filter parameter of ne_pk so a single appliance can be retrieved instead of all appliances

• get_appliance_info()

  • Raise warning on deprecation for 9.3+, handles same endpoint logic as get_appliances()

• delete_appliance()

• delete_appliance_for_rediscovery()

• delete_denied_appliances()

• add_and_approve_discovered_appliances()

• add_discovered_appliances()

• deny_appliance()

• rediscover_denied_appliance()

• change_appliance_credentials()

• appliance_get_api()

• appliance_post_api()

• appliance_delete_api()

• get_appliance_dns_cache_config()

APPLIANCE_BACKUP

• backup_appliance_config()

• get_appliance_backup_history()

• delete_appliance_backup()

• restore_appliance_from_backup()

APPLIANCE_EXTRA_INFO

• get_appliance_extra_info()

• set_appliance_extra_info()

• delete_appliance_extra_info()

APPLIANCE_PRECONFIG

• modify_preconfig()

• delete_preconfig()

• approve_and_apply_preconfig()

• apply_preconfig_to_existing()

• get_apply_preconfig_status()

APPLIANCE_RESYNC

• appliance_resync()

APPLIANCES_SOFTWARE_VERSIONS

• get_appliance_software_version()

APPLIANCE_UPGRADE

• delete_ecos_image()

APPLICATION_DEFINITION

• update_user_defined_app_port_protocol()

• delete_user_defined_app_port_protocol()

• update_user_defined_app_dns_classification()

• delete_user_defined_app_dns_classification()

• post_user_defined_app_address_map()

• delete_user_defined_app_address_map()

• post_user_defined_app_meter_flow()

• delete_user_defined_app_meter_flow()

APP_SYSTEM_DEPLOY_INFO

• get_appliance_system_deployment_info()

APP_SYSTEM_STATE_INFO

• get_appliance_system_state_info()

AUTHENTICATION

• get_appliance_auth_information()

BANNERS

• get_appliance_login_banners()

BGP

• get_appliance_bgp_config()

• get_appliance_bgp_config_all_vrfs()

• get_appliance_bgp_neighbors()

• get_appliance_bgp_neighbors_all_vrfs()

• get_appliance_bgp_state()

• get_appliance_bgp_state_all_vrfs()

BONDED_TUNNELS_CONFIGURATION

• get_bonded_tunnel_details_for_appliance()

• get_bonded_tunnels_for_physical_tunnel()

• get_bonded_tunnels_state()

BRIDGE_INTERFACE_STATE

• get_appliance_bridge_interface_state()

BROADCAST_CLI

• broadcast_cli()

BUILT_IN_POLICIES

• get_built_in_policies()

CUSTOM_APPLIANCE_TAGS

• get_custom_appliance_tags()

DEBUG_FILES

• get_debug_files_from_appliance()

• delete_debug_file_from_appliance()

• generate_appliance_sysdump()

DEPLOYMENT

• get_appliance_deployment()

• get_single_appliance_deployment()

DISKS

• get_appliance_disk_information()

DNS

• get_appliance_dns()

DNS_PROXY

• get_dns_proxy()

EXCEPTION

• delete_single_tunnel_exception()

• update_single_tunnel_exception()

FLOW

• get_appliance_flows()

• reset_flows()

• reclassify_flows()

• get_appliance_flow_bandwidth_stats()

• get_appliance_flow_details()

• get_appliance_flow_details_verbose()

GRNODE

• get_appliance_location()

• update_appliance_location_grnodepk()

• update_appliance_location_nepk()

GROUP

• get_gms_group()

• update_gms_group()

• delete_gms_group()

INBOUND_SHAPER

• get_appliance_inbound_shaper()

INTERFACE_LABELS

• push_interface_labels_to_appliance()

INTERFACE_STATE

• get_appliance_interface_state()

IP_OBJECTS

• get_address_group()

• delete_address_group()

• get_service_group()

• delete_service_group()

LICENSE

• change_appliance_license()

• grant_appliance_base_license()

• revoke_appliance_base_license()

• delete_appliance_license_token()

LINK_AGGREGATION

• get_link_aggregation_data()

LINK_INTEGRITY

• get_link_integrity_test_result()

LOGGING

• get_appliance_syslog_config()

LOOPBACK

• get_loopback_interfaes()

MGMT_SERVICES

• get_mgmt_services()

MULTICAST

• get_appliance_multicast_enabled()

• get_appliance_multicast_config()

• get_appliance_multicast_interfaces()

• get_appliance_multicast_neighbors()

• get_appliance_multicast_routes()

NAT

• get_appliance_nat_config()

• get_appliance_nat_pools()

• get_appliance_nat_maps()

NAT_MAPS

• get_nat_policy()

• get_nat_policy_inbound_outbound()

• get_nat_policy_dynamic()

NET_FLOW

• get_net_flow_configuration()

NETWORK_MEMORY

• erase_appliance_network_memory()

NETWORK_ROLE_AND_SITE

• get_appliance_network_role_and_site()

• update_appliance_network_role_and_site()

OPTIMIZATION_POLICY

• get_optimization_policy()

OSPF

• get_appliance_ospf_config()

• get_appliance_ospf_interfaces_config()

• get_appliance_ospf_state()

• get_appliance_ospf_interfaces_state()

• get_appliance_ospf_neighbors_state()

OVERLAY_ASSOCIATION

• get_appliance_overlay_association()

• remove_single_appliance_overlay_association()

OVERLAYS

• get_overlay_config()

• modify_overlay_config()

• delete_overlay()

• get_overlay_config_for_region()

• modify_overlay_config_for_region()

PEER_PRIORITY

• get_peer_priority_configuration()

PORT_FORWARDING

• get_appliance_port_fowarding()

QOS_POLICY

• get_qos_policy()

REACHABILITY

• get_reachability_status_appliance()

• get_reachability_status_orchestrator()

REALTIME_STATS

• get_realtime_stats()

REGIONS

• get_region()

• update_region_name()

• delete_region()

• update_region_appliance_association()

• get_region_appliance_association_by_nepk()

• get_region_appliance_association_by_region_id()

RELEASES

• delay_release_notification()

• dismiss_release_notification()

ROUTE_POLICY

• get_route_policy()

SAVE_CHANGES

• save_changes_ne_pk_list()

• save_changes_single_appliance()

SECURITY_MAPS

• get_appliance_security_maps()

SHAPER

• get_appliance_shaper()

SNMP

• get_appliance_snmp()

SUBNETS

• get_appliance_subnets()

• get_discovered_appliance_subnets()

• set_appliance_subnet_sharing_options()

TCA

• get_appliance_tca()

• get_appliance_tunnel_tca()

TCPDUMP

• pyedgeconnect.Orchestrator.tcpdump_status_appliance()

TEMPLATE

• pyedgeconnect.Orchestrator.get_template_group()

• pyedgeconnect.Orchestrator.post_template_group()

• pyedgeconnect.Orchestrator.delete_template_group()

• pyedgeconnect.Orchestrator.get_selected_templates_in_template_group()

• pyedgeconnect.Orchestrator.select_templates_for_template_group()

• pyedgeconnect.Orchestrator.get_appliance_template_history()

• pyedgeconnect.Orchestrator.get_appliance_applied_template_goups()

• pyedgeconnect.Orchestrator.get_appliance_template_groups_association()

• pyedgeconnect.Orchestrator.associate_template_group_to_appliance()

THIRD_PARTY_SERVICES

• central_assign_appliance_to_site()

TIMESERIES_STATS

• get_timeseries_stats_appliance_process_state()

• get_timeseries_stats_orchestrator_memory()

• get_timeseries_stats_tunnel_single_appliance()

• get_timeseries_stats_appliances()

• get_timeseries_stats_appliances_ne_pk_list()

• get_timeseries_stats_appliances_single_appliance()

• get_timeseries_stats_traffic_class()

• get_timeseries_stats_traffic_class_ne_pk_list()

• get_timeseries_stats_traffic_class_single_appliance()

• get_timeseries_stats_flow()

• get_timeseries_stats_flow_ne_pk_list()

• get_timeseries_stats_flow_single_appliance()

• get_timeseries_stats_dscp()

• get_timeseries_stats_dscp_ne_pk_list()

• get_timeseries_stats_dscp_single_appliance()

• get_timeseries_stats_shaper()

• get_timeseries_stats_shaper_ne_pk_list()

• get_timeseries_stats_internal_drops_single_appliance()

• get_timeseries_stats_drc()

• get_timeseries_stats_drc_ne_pk_list()

• get_timeseries_stats_drc_single_appliance()

• get_timeseries_stats_interface_single_appliance()

• get_timeseries_stats_interface_overlay_single_appliance()

• get_timeseries_stats_mos_single_appliance()

• get_timeseries_stats_application()

• get_timeseries_stats_application_ne_pk_list()

• get_timeseries_stats_application_single_appliance()

• get_timeseries_stats_boost_single_appliance()

• get_timeseries_stats_security_policy_single_appliance()

• get_timeseries_stats_jitter_single_appliance()

UI_USAGE_STATS

• add_ui_usage_count()

UPGRADE_APPLIANCES

• upgrade_appliances()

USER_ACCOUNT

• get_appliance_user_accounts()

USERS

• get_user()

• delete_user()

• create_or_update_user()

• change_user_password()

VRF

• get_routing_segmentation_segment_by_id()

• update_routing_segmentation_segment_by_id()

• delete_routing_segmentation_segment_by_id()

• get_routing_segmentation_maps_from_source_segment()

• update_routing_segmentation_maps_from_source_segment()

• delete_routing_segmentation_maps_from_source_segment()

• get_routing_segmentation_security_policy()

• update_routing_segmentation_security_policy()

VRF_DNAT_MAPS

• get_dnat_maps()

VRF_SNAT_MAPS

• get_snat_maps()

VRRP

• get_vrrp_interfaces()

VTI

• get_vti_interfaes()

VXOA_HOSTNAME

• update_appliance_hostname()

WAN_NEXT_HOP_HEALTH

• get_wan_next_hop_health_config()

Updated functions with new parameters:

APPLICATION_DEFINITION

• post_user_defined_app_address_map() - Added subattributes parameter for supporting additional app definition details in 9.2+

Added the following Orchestrator functions from Swagger Incl. Support for 9.3+:

Health

• get_health_appliance_summary()

• get_health_alarm_summary()

• get_health_threshold_config()

• set_health_threshold_config()

• get_health_jitter()

• get_health_latency()

• get_health_loss()

• get_health_mos()

Third Party Services / Service Orchestration

• get_service_orchestration_breakout_state()

• set_service_orchestration_breakout_state()

• get_service_orchestration_labels()

• set_service_orchestration_labels()

• get_service_orchestration_all_names_to_ids()

• get_service_orchestration_all_services()

• add_new_service_orchestration()

• delete_service_orchestration()

• get_service_orchestration_tunnel_settings()

• set_service_orchestration_tunnel_settings()

• get_service_orchestration_tunnel_identifiers()

• get_service_orchestration_config_entries()

• get_service_orchestration_ipsla_settings()

• set_service_orchestration_ipsla_settings()

• get_service_orchestration_remote_endpoints()

• set_service_orchestration_remote_endpoints()

• add_service_orchestration_remote_endpoints()

• delete_service_orchestration_remote_endpoints()

• get_service_orchestration_appliance_association()

• set_service_orchestration_appliance_association()

Added the following EdgeConnect functions from Swagger:

• get_traffic_class_names()

• set_traffic_class_names()

• update_appliance_deployment()

• validate_appliance_deployment()

• get_vrrp_interfaces()

• configure_vrrp_interfaces()

🐛 Bug Fixes

• #6 - get_appliance_bgp_state_all_vrfs() Updated endpoint path as it was in an incorrect order resulting in bad response.

• #8 - Added 9.3 support for appliance preconfig endpoints

• #2 - Added 9.3 support for vrf/segmentation endpoints

• get_appliance_routing_peers_info() Updated docstring formatting due to indentation typo

• update_region_name() Updated body to include previously unused paramter region_name to update the name of a region.

💥 Breaking Changes:

• update_routing_segmentation_security_policy()

Renamed parameters source_zone and destination_zone to source_segment and destination_segment as the inputs are segment ID values and not FW zone values. If this function is being used without explicit arguments no breaking change is encountered but if users are calling the function with explicit keyword arguments of the old parameter names then the code will need to be updated to reflect the updated parameter names.

🧰 Maintenance / Other

🐛 Known Issues

Warning

The following two functions for the _ip_objects submodule experience errors at this time. These function do work in the Orchestrator UI: bulk_upload_address_group() and bulk_upload_service_group()