Skip to content

Latest commit

 

History

History
686 lines (471 loc) · 26 KB

0.16.0-a1.rst

File metadata and controls

686 lines (471 loc) · 26 KB

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 :func:`~pyedgeconnect.Orchestrator.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

ADMIN_DISTANCE

AGGREGATE_STATS

ALARM

API_KEYS

APPLIANCE

APPLIANCE_BACKUP

APPLIANCE_EXTRA_INFO

APPLIANCE_PRECONFIG

APPLIANCE_RESYNC

APPLIANCES_SOFTWARE_VERSIONS

APPLIANCE_UPGRADE

APPLICATION_DEFINITION

APP_SYSTEM_DEPLOY_INFO

APP_SYSTEM_STATE_INFO

AUTHENTICATION

BANNERS

BGP

BONDED_TUNNELS_CONFIGURATION

BRIDGE_INTERFACE_STATE

BROADCAST_CLI

BUILT_IN_POLICIES

CUSTOM_APPLIANCE_TAGS

DEBUG_FILES

DEPLOYMENT

DISKS

DNS

DNS_PROXY

EXCEPTION

FLOW

GRNODE

GROUP

INBOUND_SHAPER

INTERFACE_LABELS

INTERFACE_STATE

IP_OBJECTS

LICENSE

LINK_AGGREGATION

LINK_INTEGRITY

LOGGING

LOOPBACK

MGMT_SERVICES

MULTICAST

NAT

NAT_MAPS

NET_FLOW

NETWORK_MEMORY

NETWORK_ROLE_AND_SITE

OPTIMIZATION_POLICY

OSPF

OVERLAY_ASSOCIATION

OVERLAYS

PEER_PRIORITY

PORT_FORWARDING

QOS_POLICY

REACHABILITY

REALTIME_STATS

REGIONS

RELEASES

ROUTE_POLICY

SAVE_CHANGES

SECURITY_MAPS

SHAPER

SNMP

SUBNETS

TCA

TCPDUMP

TEMPLATE

THIRD_PARTY_SERVICES

TIMESERIES_STATS

UI_USAGE_STATS

UPGRADE_APPLIANCES

USER_ACCOUNT

USERS

VRF

VRF_DNAT_MAPS

VRF_SNAT_MAPS

VRRP

VTI

VXOA_HOSTNAME

WAN_NEXT_HOP_HEALTH

Updated functions with new parameters:

APPLICATION_DEFINITION

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

Health

Third Party Services / Service Orchestration

Added the following EdgeConnect functions from Swagger:

🐛 Bug Fixes

💥 Breaking Changes:

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: :func:`~pyedgeconnect.Orchestrator.bulk_upload_address_group` and :func:`~pyedgeconnect.Orchestrator.bulk_upload_service_group`