April 2021 Controller Release

CloudGenix Python SDK v5.5.1b1 Release Info.

Notable API changes:

CloudGenix 5.5.1 API Major Version Changes:

• None

CloudGenix 5.5.1 API Minor Version Changes:

• anynetlinks_correlationevents (v2.0 to v2.1)
• clients_machines (v2.0 to v2.1)
• clients_machines_query (v2.0 to v2.1)
• clients_reallocate (v2.0 to v2.1)
• elements (v2.3 to v2.4)
• elements_query (v2.3 to v2.4)
• events (v2.1 to v2.2)
• events_query (v3.2 to v3.3)
• idps (v3.0 to v3.2)
• interface (v4.9 to v4.10)
• interfaces_query (v4.9 to v4.10)
• interfaces_status (v3.1 to v3.2)
• machines (v2.0 to v2.1)
• machines_query (v2.0 to v2.1)
• monitor_flows (v3.5 to v3.6)
• monitor_metrics (v2.1 to v2.2)
• monitor_sys_metrics (v2.0 to v2.1)
• monitor_topn (v3.0 to v3.1)
• routing_routemaps (v2.0 to v2.1)
• routing_routemaps_query (v2.0 to v2.1)
• sdwanapps (v2.1 to v2.2)
• staticroutes (v2.0 to v2.1)
• tenant_machine_operations (v2.0 to v2.1)
• topology (v3.2 to v3.3)
• waninterfacelabels (v2.2 to v2.3)
• waninterfacelabels_query (v2.2 to v2.3)
• waninterfaces (v2.5 to v2.6)

Notable SDK changes:

EventCorrelation PolicyRules and PolicySets API

• New Event Correlation Policy Rules and Policy Sets API
• Also added query functions and eventcodes function for above API's.

IPFix API

• New IPFix API
• New IPFixCollectorContexts API
• New IPFix Filter Contexts API
• New IPFix Global and Local Prefixes API
• New IPFix Profiles API
• New Site IPFix Local Prefixes API
• New Tenant IPFix Local Prefixes API
• Added query functions for above API's

Certificate and External CA Config API.

• Following new functions were added for certificate and CA config API:
  • certificates
  • certificate_operations
  • externalcaconfig
  • certificates_revoked

TopN Sys Metrics API.

• New monitor_sys_metrics_topn API

Static Route Status API

• Added support for static route status

BgpPeers Query API

• Added support for tenant level bgppeers query

Changed SDK Functions:

None

Removed SDK Functions:

• request_get_site_best_art
• request_get_site_best_bw_usage
• request_site_best_app_path
• request_sites_best_app_path
• site_best_app_path
• sites_best_app_path
• get_site_best_art
• get_site_best_bw_usage

October 2020 Controller Release

CloudGenix Python SDK v5.4.3b1 Release Info.

Notable API changes:

CloudGenix 5.4.3 API Major Version Changes:

• None

CloudGenix 5.4.3 API Minor Version Changes:

• idps (v3.0 to v3.1)
• routing_routemaps (v2.0 to v2.1)
• routing_routemaps_query (v2.0 to v2.1)
• sdwanapps (v2.1 to v2.2)
• waninterfacelabels (v2.2 to v2.3)
• waninterfacelabels_query (v2.2 to v2.3)
• waninterfaces (v2.5 to v2.6)

Notable SDK changes:

BFDPeers API.

• Added support for BFDPeers API

WanInterface API

• New WanInterface Query api tenant_waninterfaces_query

Changed SDK Functions:

• query_correlationevents_anynetlinks renamed to anynetlinks_correlationevents_query (backwards compatible)
• query_correlationevents_e renamed to anynetlinks_correlationevents_query (backwards compatible)
• query_correlationevents_interfaces renamed to anynetlinks_correlationevents_query (backwards compatible)
• query_correlationevents_s renamed to anynetlinks_correlationevents_query (backwards compatible)
• query_correlationevents_waninterfaces renamed to anynetlinks_correlationevents_query (backwards compatible)
• query_dnsserviceprofiles renamed to dnsserviceprofiles_query (backwards compatible)
• query_dnsserviceroles renamed to dnsserviceroles_query (backwards compatible)
• query_dnsservices renamed to anynetlinks_correlationevents_query (backwards compatible)
• query_securitypolicyrules renamed to anynetlinks_correlationevents_query (backwards compatible)

July 2020 Controller Release

CloudGenix Python SDK v5.4.1b1 Release Info.

Notable API changes:

• policysetrules_query - Removed requirement to specify policyset ID

CloudGenix 5.4.1 API Major Version Changes:

• None

CloudGenix 5.4.1 API Minor Version Changes:

• appdefs (v2.2 to v2.3)
• appdefs_overrides (v2.1 to v2.2)
• bgppeers (v2.1 to v2.2)
• bgppeers_query (v2.1 to v2.2)
• events (v2.0 to v2.1)
• events_query (v3.1 to v3.2)
• interfaces (v4.8 to v4.9)
• interfaces_query (v4.8 to v4.9)
• monitor_flows (v3.4 to v3.5)
• routing_aspathaccesslists (v2.0 to v2.1)
• routing_aspathaccesslists_query (v2.0 to v2.1)
• tenant_anynetlinks (v3.1 to v3.2)
• topology (v3.1 to v3.2)
• vpnlinks_status (v2.0 to v2.1)
• waninterfacelabels (v2.1 to v2.2)
• waninterfacelabels_query (v2.1 to v2.2)
• waninterfaces (v2.4 to v2.5)

Notable SDK changes:

DNS Resolver/Forwarding Service on ION Element.

• Support DNS Service on ION element (Release 5.4.1+)
  • dnsserviceprofiles API
  • dnsserviceroles API
  • dnsservices API

Correlation Events API initial framework to support correlation across systems.

• Initial framework for correlationevents Status APIs.
  • anynetlinks_correlationevents API
  • elements_correlationevents API
  • interfaces_correlationevents API
  • sites_correlationevents API
  • wantinterfaces_correlationevents API
  • Also added "query" APIs for above APIs.

April 2020 Controller Release

CloudGenix Python SDK v5.3.1b1 Release Info.

Notable API changes:

CloudGenix 5.3.1 API Major Version Changes:

• None

CloudGenix 5.3.1 API Minor Version Changes:

• interfaces (v4.7 to v4.8)

Notable SDK changes:

MSP Reallocation Support.

• Support for reallocation of declaimed IONs between tenants managed by a MSP.

SDWANAPPS status framework.

• Initial framework for SDWANAPPS Status APIs.

Changed SDK Functions:

• reallocate_clients renamed to clients_reallocate (backwards compatible)

Support for March 2020 Controller Release

CloudGenix Python SDK v5.2.3b1 Release Info.

Notable API changes:

CloudGenix 5.2.3 API Major Version Changes:

• None

CloudGenix 5.2.3 API Minor Version Changes:

• interfaces_status (v3.0 to v3.1)
• sites (v4.4 to v4.5)

Notable SDK changes:

ESP/MSP support for moving/reallocating IONs between sub-tenants (clients).

• New ESP/MSP functions to facilitate this capability:
  • clients_machines
  • clients_machines_query
  • clients_query
  • reallocate_clients

Changed SDK Functions:

• Updated extract_items function.
  • Now allows for extracting items from keys other than items by passing a key value to items_key.

January 2020 Controller Release

CloudGenix Python SDK v5.2.1b1 Release Info.

Notable API changes:

CloudGenix 5.2.1 API Major Version Changes:

• idps (v2.0 to v3.0)

CloudGenix 5.2.1 API Minor Version Changes:

• appdefs (v2.1 to v2.2)
• appdefs_overrides (v2.0 to v2.1)
• appdefs_query (v2.1 to v2.2)
• auditlog (v2.0 to v2.1)
• auditlog_query (v2.0 to v2.1)
• authtokens (v2.0 to v2.1)
• bgpconfigs (v2.0 to v2.1)
• bgppeers (v2.0 to v2.1)
• bgppeers_query (v2.0 to v2.1)
• bgppeers_status (v2.0 to v2.1)
• dhcpservers (v2.0 to v2.1)
• element_bgppeers_status (v2.0 to v2.1)
• elements (v2.2 to v2.3)
• elements_query (v2.2 to v2.3)
• interfaces (v4.6 to v4.7)
• ipsecprofiles (v2.0 to v2.1)
• ipsecprofiles_query (v2.0 to v2.1)
• networkpolicyrules (v2.0 to v2.1)
• networkpolicyrules_query (v2.0 to v2.1)
• networkpolicysets (v2.0 to v2.1)
• sites (v4.3 to v4.4)
• sites_query (v4.3 to v4.4)
• syslogservers (v2.0 to v2.1)
• tenant_anynetlinks (v3.0 to v3.1)
• tenant_operators (v2.0 to v2.1)
• topology (v3.0 to v3.1)
• waninterfaces (v2.3 to v2.4)
• waninterfaces_query (v2.3 to v2.4)

Notable SDK changes:

WebSocket support (Python 3.6 and higher only).

• Support for Websocket connections to the controller. Uses Python "Websockets" library. Will only be present for users of Python 3.6 and higher. Support is integrated directly into the API() object.

NAT Policy Set Stack support - Flexible policy-driven NAT support for CloudGenix IONs running 5.2.1 or higher.

• Support for natpolicysetstacks objects and related functions:
  • natglobalprefixes
  • natglobalprefixes_query
  • natlocalprefixes
  • natlocalprefixes_query
  • natpolicypools
  • natpolicypools_query
  • natpolicyrules
  • natpolicyrules_query
  • natpolicysets
  • natpolicysets_query
  • natpolicysets_status
  • natpolicysetstacks
  • natpolicysetstacks_query
  • natzones
  • natzones_query
  • site_natlocalprefixes

Toolkit Session - Connection to CloudGenix IONs running 5.2.1 or higher via encrypted Controller WebSocket connection

• Support streaming interactive session to IONs via controller WebSocket. Requires Python 3.6 or higher and IONs running 5.2.1 or higher. Related APIs:
  • toolkit_session in ws

Default WebSocket - Connection to the CloudGenix Controller via encrypted WebSocket for multiple operations

• Support streaming interactive session CloudGenix Controller. Used for current and future streaming telemetry. Initial capabilities:
  • config_change streaming notifications.

Error/Warning side channel message support.

• CloudGenix extended requests.Response objects now include cgx_errors and cgx_warnings to give more easily accessible info on failed requests.

Helper functions to do frequently used operations.

• New helper functions to do common operations directly in the SDK itself:
  • throw_error: Throw a customizable Exception with custom text to stderr and optionally a CloudGenix extended requests.Response request to print in detail.
  • throw_warning: Send custom text to stderr and optionally a CloudGenix extended requests.Response request to print in detail. Does not raise an Exception.
  • throw_warning: Send custom text to stderr and optionally a CloudGenix extended requests.Response request to print in detail. Does not raise an Exception.
  • extract_items: Safely extract items from an items key in a CloudGenix extended requests.Response.
  • build_lookup_dict: Create an arbitrary key/value lookup/mapping dictionary from any CloudGenix object. Defaults to Name to ID.

UPDATED support for MSP/ESP Client login/logout

• New capabilities for ESPs/MSPs to log in/log out of clients seamlessly. Check interactive.login() and interactive.use_token() documentation for more info.

Removed SDK Functions:

• None

Changed SDK Functions:

• advertisedprefixes_bgppeers renamed to bgppeers_advertisedprefixes (backwards compatible)
• discoveredprefixes_bgppeers renamed to bgppeers_discoveredprefixes (backwards compatible)
• base_roles_clients renamed to clients_base_roles (backwards compatible)
• login_clients renamed to clients_login (backwards compatible)
• logout_clients renamed to clients_logout (backwards compatible)
• roles_clients renamed to clients_roles (backwards compatible)
• password_elementusers renamed to elementusers_password (backwards compatible)
• aggregates_monitor renamed to monitor_aggregates (backwards compatible)
• bulk_metrics_monitor renamed to monitor_bulk_metrics (backwards compatible)
• flows_monitor renamed to monitor_flows (backwards compatible)
• metrics_monitor renamed to monitor_metrics (backwards compatible)
• object_stats_monitor renamed to monitor_object_stats (backwards compatible)
• sys_metrics_monitor renamed to monitor_sys_metrics (backwards compatible)
• topn_monitor renamed to monitor_topn (backwards compatible)
• change_password renamed to password_change (backwards compatible)
• query_current_status_software renamed to software_current_status_query (backwards compatible)
• query_status_software renamed to software_status_query (backwards compatible)
• query_softwarehistory renamed to softwarehistory_query (backwards compatible)
• ops_spokeclusters renamed to spokeclusters_ops (backwards compatible)
• ntp_templates renamed to templates_ntp (backwards compatible)
• state_vpnlinks renamed to vpnlinks_state (backwards compatible)

June 2019 Controller Release

CloudGenix Python SDK v5.1.5b1 Release Info.

Notable API changes:

CloudGenix 5.1.5 API Major Version Changes:

• None

CloudGenix 5.1.5 API Minor Version Changes:

• sdwanapps (v2.0 to v2.1)

Notable SDK changes:

• None

Removed SDK Functions:

• None

Changed SDK Functions:

• None

November 2018 Controller Release

CloudGenix Python SDK v5.1.1b1 Release Info.

Notable API changes:

CloudGenix 5.1.1 API Major Version Changes:

• None

CloudGenix 5.1.1 API Minor Version Changes:

• elements (v2.1 to v2.2)
• elements_query (v2.1 to v2.2)
• esp_operator_permissions_client (v2.0 to v2.1)
• interfaces (v4.5 to v4.6)
• lannetworks (v3.0 to v3.1)
• lannetworks_query (v3.0 to v3.1)
• serviceendpoints (v2.1 to v2.2)
• serviceendpoints_query (v2.1 to v2.2)
• sites (v4.2 to v4.3)
• sites_query (v4.2 to v4.3)
• software_status (v2.0 to v2.1)
• waninterfacelabels (v2.0 to v2.1)
• waninterfacelabels_query (v2.0 to v2.1)
• waninterfaces (v2.2 to v2.3)
• waninterfaces_query (v2.1 to v2.3)
• wannetworks (v2.0 to v2.1)
• wannetworks_query (v2.0 to v2.1)

Notable SDK changes:

Spoke Cluster support - Branch location high-availability objects.

• Support for spokecluster objects and related functions:
  • spokeclusters
  • spokeclusters_ops
  • spokeclusters_query
  • spokeclusters_status

SDWAN Extensions (sdwanapps) support. Custom extensions store to allow external feature integration apps.

• Support for sdwanapps objects and related functions:
  • sdwanapps
  • sdwanapps_configs
  • sdwanapps_status

Software Upgrade Redesign - Enhanced preload and upgrading of CloudGenix Element Software.

• software_status function updated, is now specifically element software status.
• Support for enhanced upgrade objects and related functions:
  • software
  • software_state
  • machines_software_status
  • machine_upgrade_query
  • software_status_query

NEW Bulk Config/Status API Support - Support for Bulk queries of config/status for certain system APIs

• Added following bulk config/status query functions:
  • elements_bulk_config_state_query
  • networks_bulk_config_state_query
  • policysets_bulk_config_state_query
  • sites_bulk_config_state_query

Removed SDK Functions:

• None

Changed SDK Functions:

• software_status redesigned in new minor version, see Software Upgrade Redesign above.

5.0.3 Patch Release (b2)

CloudGenix Python SDK v5.0.3b2 Release Info.

Notable API changes:

• CloudGenix 5.0.3 API Major Version Changes:

  • None

• CloudGenix 5.0.3 API Minor Version Changes:

  • None

Notable SDK changes:

• Replaced optional retry system with new default retry behavior using native urllib3 Retry objects.
• Added a new function to modify retry timers.
• Added new functions to view retry timers, view cookies, and view headers in API().

New SDK Functions:

• modify_rest_retry - Modify default rest_call timeout handling parameters
• view_rest_retry - View current rest_call timeout settings
• view_headers - View current headers set in the API() session.
• view_cookies - View current cookies set in the API() session.

September 2018 Controller Release

CloudGenix Python SDK v5.0.3b1 Release Info.

Notable API changes:

• CloudGenix 5.0.3 API Major Version Changes:

  • None

• CloudGenix 5.0.3 API Minor Version Changes:

  • flows_monitor (v3.3 to v3.4)
  • interfaces (v4.4 to v4.5)
  • waninterfaces (v2.1 to v2.2)

Notable SDK changes:

• Updated upgrade-check message to explain SDK deprecation schedule.
• Updated several function documentation strings to be more descriptive.

New SDK Functions:

• tenant_extensions related functions
• ws_extenstion related functions