Anapaya API client libraries for Python.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for anapaya from gravatar.com anapaya Avatar for worxli from gravatar.com worxli

Unverified details

These details have not been verified by PyPI
Meta
  • Requires: Python >=3.7
Report project as malware

Project description

anapaya-appliance

Management API for the Anapaya EDGE, CORE and GATE appliances

The anapaya.appliance package is automatically generated by the OpenAPI Generator project:

  • API version: v0.40
  • Package version: 0.1
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

Python 3.7+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.25.3
  • python-dateutil
  • pydantic

Getting Started

In your own code, to use this library to connect and interact with anapaya.appliance, you can run the following:

import time
import anapaya.appliance
from anapaya.appliance.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://localhost:443/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = anapaya.appliance.Configuration(
    host = "https://localhost:443/api/v1"
)

# Enter a context with an instance of the API client
with anapaya.appliance.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = anapaya.appliance.ConfigApi(api_client)
    service_type = anapaya.appliance.ServiceType("FRR") # ServiceType

    try:
        # Get service customization
        api_response = api_instance.config_advanced_service_customization_get(service_type)
        print("The response of ConfigApi->config_advanced_service_customization_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConfigApi->config_advanced_service_customization_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost:443/api/v1

Class Method HTTP request Description
ConfigApi config_advanced_service_customization_get GET /config/advanced/service-customization/{service_type} Get service customization
ConfigApi config_advanced_service_customization_template_execute_post POST /config/advanced/service-customization/{service_type}/template/execute Render custom server template
ConfigApi config_advanced_service_customization_template_get GET /config/advanced/service-customization/{service_type}/template Get custom service template
ConfigApi config_advanced_service_customization_template_put PUT /config/advanced/service-customization/{service_type}/template Set custom service template
ConfigApi config_diff_post POST /config/diff Diff config to provided
ConfigApi config_get GET /config Get configuration
ConfigApi config_put PUT /config Set configuration
ConfigApi config_validate_post POST /config/validate Validate provided configuration
ConfigApi configs_get GET /configs List configuration versions
ConfigApi configs_latest_diff_post POST /configs/latest/diff Diff configuration to previous
ConfigApi configs_latest_diff_reference_post POST /configs/latest/diff/{reference} Diff configuration to reference version
ConfigApi configs_latest_get GET /configs/latest Get latest configuration
ConfigApi configs_post POST /configs Add configuration
ConfigApi configs_releases_get GET /configs/releases List configuration versions across releases
ConfigApi configs_releases_release_get GET /configs/releases/{release} List configuration versions for release
ConfigApi configs_releases_release_version_get GET /configs/releases/{release}/{version} Get configuration version for release
ConfigApi configs_version_diff_post POST /configs/{version}/diff Diff configuration version to previous
ConfigApi configs_version_diff_reference_post POST /configs/{version}/diff/{reference} Diff configuration version to reference version
ConfigApi configs_version_get GET /configs/{version} Get configuration version
ConfigApi configs_version_reapply_post POST /configs/{version}/reapply Reapply previous configuration
CppkiApi cppki_certificate_blob_get GET /cppki/certificates/{chain_id}/blob Get certificate blob
CppkiApi cppki_certificate_get GET /cppki/certificates/{chain_id} Get certificate
CppkiApi cppki_certificates_get GET /cppki/certificates List certificates
CppkiApi cppki_certificates_post POST /cppki/certificates Add certificate
CppkiApi cppki_certificates_renew_post POST /cppki/certificates/renew Renew certificate
CppkiApi cppki_certificates_request_post POST /cppki/certificates/request Request certificate
CppkiApi cppki_csr_blob_get GET /cppki/csrs/{csr_id}/blob Get CSR blob
CppkiApi cppki_csr_get GET /cppki/csrs/{csr_id} Get CSR
CppkiApi cppki_csrs_get GET /cppki/csrs List CSRs
CppkiApi cppki_csrs_post POST /cppki/csrs Create CSR
CppkiApi cppki_trc_blob_get GET /cppki/trcs/isd{isd}-b{base}-s{serial}/blob Get TRC blob
CppkiApi cppki_trc_get GET /cppki/trcs/isd{isd}-b{base}-s{serial} Get TRC
CppkiApi cppki_trcs_bundle_post POST /cppki/trcs/bundle Add TRC bundle
CppkiApi cppki_trcs_get GET /cppki/trcs List TRCs
CppkiApi cppki_trcs_post POST /cppki/trcs Add TRC
DebugApi debug_bgp_config_get GET /debug/bgp/config Get BGP configuration
DebugApi debug_bgp_neighbors_get GET /debug/bgp/neighbors Get BGP neighbors state
DebugApi debug_cluster_status_get GET /debug/cluster/status Get cluster status
DebugApi debug_lan_monitoring_get GET /debug/lan-monitoring Get LAN statistics
DebugApi debug_logs_entries_get GET /debug/logs/entries Retrieve logs via systemd-journal-gatewayd compatible interface
DebugApi debug_network_interfaces_get GET /debug/network/interfaces List network interfaces
DebugApi debug_network_planner_graph_get GET /debug/network/planner/graph Get graph of dataplane-control planner nodes
DebugApi debug_network_routes_get GET /debug/network/routes List network routes
DebugApi debug_notifications_get GET /debug/notifications Get periodic appliance-controller notification status
DebugApi debug_notifications_post POST /debug/notifications Trigger appliance-controller notification
DebugApi debug_notifications_put PUT /debug/notifications Enable/disable periodic appliance-controller notifications
DebugApi debug_scion_interfaces_get GET /debug/scion/interfaces List SCION interfaces
DebugApi debug_scion_tunneling_discovery_announcements_get GET /debug/scion-tunneling/discovery/announcements List announced IP-in-SCION tunneling endpoints
DebugApi debug_scion_tunneling_discovery_get GET /debug/scion-tunneling/discovery List IP-in-SCION tunneling peers
DebugApi debug_scion_tunneling_domains_config_get GET /debug/scion-tunneling/domains/config Get IP-in-SCION tunneling domains configuration
DebugApi debug_scion_tunneling_paths_get GET /debug/scion-tunneling/paths List IP-in-SCION tunneling paths
DebugApi debug_scion_tunneling_paths_search_post POST /debug/scion-tunneling/paths/search Search IP-in-SCION tunneling paths
DebugApi debug_scion_tunneling_planner_graph_get GET /debug/scion-tunneling/planner/graph The graph of the planner nodes and dependencies.
DebugApi debug_scion_tunneling_sa_reset_post POST /debug/scion-tunneling/sa/reset Reset the SAs of the SCION tunnels.
DebugApi debug_scion_tunneling_sgrp_announcements_get GET /debug/scion-tunneling/sgrp/announcements List IP-in-SCION tunneling announced prefixes
DebugApi debug_scion_tunneling_sgrp_domains_get GET /debug/scion-tunneling/sgrp/domains List IP-in-SCION tunneling SGRP domains
DebugApi debug_scion_tunneling_sgrp_local_prefixes_get GET /debug/scion-tunneling/sgrp/local-prefixes List IP-in-SCION tunneling local prefixes
DebugApi debug_scion_tunneling_sgrp_peers_get GET /debug/scion-tunneling/sgrp/peers List IP-in-SCION tunneling SGRP peers
DebugApi debug_scion_tunneling_state_current_get GET /debug/scion-tunneling/state/current Get IP-in-SCION tunneling state
DebugApi debug_scion_tunneling_state_domains_get GET /debug/scion-tunneling/state/domains Get IP-in-SCION tunneling domain configuration
DebugApi debug_scion_tunneling_state_fastpath_get GET /debug/scion-tunneling/state/fastpath Get IP-in-SCION tunneling fastpath state
DebugApi debug_scion_tunneling_state_monitored_get GET /debug/scion-tunneling/state/monitored Get IP-in-SCION tunneling monitored state
DebugApi debug_scion_tunneling_state_observability_get GET /debug/scion-tunneling/state/observability Get IP-in-SCION tunneling observability data
DebugApi debug_scion_tunneling_summary_get GET /debug/scion-tunneling/summary Get IP-in-SCION tunneling summary
DebugApi debug_service_groups_restart_post POST /debug/service-groups/{group_name}/restart Restart group of services
DebugApi debug_services_get GET /debug/services List services and service groups
DebugApi debug_services_health GET /debug/services/{service_name}/health Indicate service health
DebugApi debug_services_health_summary GET /debug/service-health Get service health
DebugApi debug_services_restart POST /debug/services/{service_name}/restart Restart service
FirewallApi firewall_chain_get GET /firewall/tables/{table_name}/chains/{chain_name} List firewall table chain rules
FirewallApi firewall_default_post POST /firewall/default Generate default firewall configuration
FirewallApi firewall_get GET /firewall Get firewall configuration
FirewallApi firewall_table_get GET /firewall/tables/{table_name} Get firewall table
HealthApi health_get GET /health Get Appliance health
InitApi configs_post POST /configs Add configuration
InitApi cppki_certificates_post POST /cppki/certificates Add certificate
InitApi cppki_csrs_post POST /cppki/csrs Create CSR
InitApi cppki_trcs_bundle_post POST /cppki/trcs/bundle Add TRC bundle
InitApi cppki_trcs_post POST /cppki/trcs Add TRC
InitApi secrets_batch_post POST /secrets/batch Add secrets batch
MigrationsApi migrations_config_get GET /migrations/{version}/config Get configuration for migration
MigrationsApi migrations_config_put PUT /migrations/{version}/config Set configuration for migration
NetworkApi network_physical_interfaces_get GET /network/physical-interfaces List physical interfaces
NetworkApi network_shuttle_get GET /network/shuttles/{interface_name} Get shuttle client
NetworkApi network_shuttle_server_get GET /network/shuttle-servers/{interface_name} Get shuttle server
NetworkApi network_shuttle_servers_get GET /network/shuttle-servers List shuttle servers
NetworkApi network_shuttles_get GET /network/shuttles List shuttle clients
NetworkApi network_wireguards_get GET /network/wireguards List Wireguard interfaces
NetworkApi network_wireguards_interface_get GET /network/wireguards/{interface_name} Get Wireguard interface
SecretsApi secrets_batch_post POST /secrets/batch Add secrets batch
SecretsApi secrets_get GET /secrets List secret IDs
SecretsApi secrets_id_delete DELETE /secrets/{id} Delete secret
SecretsApi secrets_post POST /secrets Add secret
SoftwareApi software_scion_install_get GET /software/scion/install/{id} Get SCION package installation status
SoftwareApi software_scion_install_post POST /software/scion/install Install SCION package
SoftwareApi software_scion_installed_get GET /software/scion/installed Get installed SCION version
SoftwareApi software_scion_package_local_cleanup_post POST /software/scion/packages/local/cleanup Clean up scion packages
SoftwareApi software_scion_package_local_delete DELETE /software/scion/packages/local/{version} Delete SCION package
SoftwareApi software_scion_package_local_get GET /software/scion/packages/local/{version} Get SCION package information
SoftwareApi software_scion_packages_local_get GET /software/scion/packages/local List SCION packages
SoftwareApi software_scion_packages_local_post POST /software/scion/packages/local Add SCION package
SoftwareApi software_system_install_get GET /software/system/install/{id} Get system package installation status
SoftwareApi software_system_install_post POST /software/system/install Install system package
SoftwareApi software_system_installed_get GET /software/system/installed Get installed system version
SoftwareApi software_system_package_local_cleanup_post POST /software/system/packages/local/cleanup Clean up system packages
SoftwareApi software_system_package_local_delete DELETE /software/system/packages/local/{version} Delete system package
SoftwareApi software_system_package_local_get GET /software/system/packages/local/{version} Get system package information
SoftwareApi software_system_packages_local_get GET /software/system/packages/local List system packages
SoftwareApi software_system_packages_local_post POST /software/system/packages/local Add system package
SoftwareLicenseApi software_license_features_get GET /software/licenses/features Get feature set mapping
SoftwareLicenseApi software_license_features_put PUT /software/licenses/features Update feature set mapping
SoftwareLicenseApi software_license_request_get GET /software/licenses/request Get license request
SoftwareLicenseApi software_license_status_get GET /software/licenses/status Get license status
SoftwareLicenseApi software_licenses_get GET /software/licenses List licenses
SoftwareLicenseApi software_licenses_id_delete DELETE /software/licenses/{id} Delete license
SoftwareLicenseApi software_licenses_id_get GET /software/licenses/{id} Get license
SoftwareLicenseApi software_licenses_post POST /software/licenses Add license
SoftwareSignaturesApi get_keys GET /software/keys List public signing keys
SoftwareSignaturesApi get_signatures GET /software/signatures/{type}/{version} Get signature
SoftwareSignaturesApi post_keys POST /software/keys Install signing keys
SoftwareSignaturesApi post_signatures POST /software/signatures/{type}/{version} Install signatures
ToolsApi tools_scion_ping_post POST /tools/scion/ping Run SCION ping
ToolsApi tools_scion_showpaths_post POST /tools/scion/showpaths Run SCION showpaths
ToolsApi tools_scion_traceroute_post POST /tools/scion/traceroute Run SCION traceroute
VppApi get_debug_vpp_address GET /debug/vpp/address Status page listing addresses on VPP interfaces.
VppApi get_debug_vpp_bfd GET /debug/vpp/bfd Status page reporting the bfd session states.
VppApi get_debug_vpp_bond GET /debug/vpp/bond Status page reporting bonds created by VPP.
VppApi get_debug_vpp_buffers GET /debug/vpp/buffers Status page reporting VPP buffers.
VppApi get_debug_vpp_clear_errors GET /debug/vpp/clear_errors Action path to clear VPP errors.
VppApi get_debug_vpp_clear_interfaces GET /debug/vpp/clear_interfaces Action path to clear the metrics on VPP interfaces.
VppApi get_debug_vpp_clear_runtime GET /debug/vpp/clear_runtime Action path to clear the VPP runtime.
VppApi get_debug_vpp_coredump GET /debug/vpp/coredumps/{filename} Download the coredump.
VppApi get_debug_vpp_coredumps GET /debug/vpp/coredumps Get the list of avaiable VPP coredumps.
VppApi get_debug_vpp_dataplane_control GET /debug/vpp/dataplane-control Dump of the VPP state set up by dataplane-control service.
VppApi get_debug_vpp_error GET /debug/vpp/error Status page reporting VPP errors.
VppApi get_debug_vpp_events GET /debug/vpp/events Status page reporting VPP events.
VppApi get_debug_vpp_fib_ip4 GET /debug/vpp/fib-ip4 Status page reporting VPP IPv4 FIB.
VppApi get_debug_vpp_fib_ip6 GET /debug/vpp/fib-ip6 Status page reporting VPP IPv6 FIB.
VppApi get_debug_vpp_fib_ll GET /debug/vpp/fib-ll Status page reporting VPP IPv6 link-local FIB.
VppApi get_debug_vpp_gateway GET /debug/vpp/gateway Dump of the VPP state set up by the gateway service.
VppApi get_debug_vpp_hardware GET /debug/vpp/hardware Status page listing hardware interfaces managed by VPP.
VppApi get_debug_vpp_interface GET /debug/vpp/interface Status page listing internal VPP interfaces.
VppApi get_debug_vpp_lacp GET /debug/vpp/lacp Status page reporting VPP LACP info.
VppApi get_debug_vpp_lcp GET /debug/vpp/lcp Status page listing interfaces mirrored from VPP to Linux.
VppApi get_debug_vpp_logging GET /debug/vpp/logging Status page reporting VPP logs.
VppApi get_debug_vpp_memory GET /debug/vpp/memory Status page reporting VPP memory.
VppApi get_debug_vpp_neighbors_ip4 GET /debug/vpp/neighbors-ip4 Status page reporting VPP IPv4 neighbors.
VppApi get_debug_vpp_neighbors_ip6 GET /debug/vpp/neighbors-ip6 Status page reporting VPP IPv6 neighbors.
VppApi get_debug_vpp_plugins GET /debug/vpp/plugins Status page listing of loaded VPP plugins.
VppApi get_debug_vpp_runtime GET /debug/vpp/runtime Status page reporting VPP runtime.
VppApi get_debug_vpp_scion_interface GET /debug/vpp/scion/interface Status page reporting the SCION interfaces.
VppApi get_debug_vpp_scion_ipfix_params GET /debug/vpp/scion/ipfix/params Status page reporting the SCION router IPFIX parameters.
VppApi get_debug_vpp_scion_ipfix_statistics GET /debug/vpp/scion/ipfix/statistics Status page reporting the SCION router IPFIX statistics.
VppApi get_debug_vpp_scion_ipfix_table GET /debug/vpp/scion/ipfix/table Status page reporting the SCION router IPFIX table.
VppApi get_debug_vpp_scion_isd_as GET /debug/vpp/scion/isd-as Status page reporting the SCION router ASes.
VppApi get_debug_vpp_scion_svc GET /debug/vpp/scion/svc Status page reporting the SCION services.
VppApi get_debug_vpp_scion_tunneling_decap_to_output GET /debug/vpp/scion-tunneling/decap-to-output SCION gateway: trace all ingress IP packets.
VppApi get_debug_vpp_scion_tunneling_dpdk_to_decap GET /debug/vpp/scion-tunneling/dpdk-to-decap SCION gateway: trace all ingress frames entering via dpdk.
VppApi get_debug_vpp_scion_tunneling_dpdk_to_encap GET /debug/vpp/scion-tunneling/dpdk-to-encap SCION gateway: trace all egress IP packets entering via dpdk.
VppApi get_debug_vpp_scion_tunneling_encap_to_output GET /debug/vpp/scion-tunneling/encap-to-output SCION gateway: trace all egress frames.
VppApi get_debug_vpp_scion_tunneling_info GET /debug/vpp/scion-tunneling/info SCION gateway: global settings.
VppApi get_debug_vpp_scion_tunneling_ipfix GET /debug/vpp/scion-tunneling/ipfix SCION gateway: Flow-reporting IPFIX packets.
VppApi get_debug_vpp_scion_tunneling_iremote_ia GET /debug/vpp/scion-tunneling/iremote-ia SCION gateway: remote ASes.
VppApi get_debug_vpp_scion_tunneling_memif_to_decap GET /debug/vpp/scion-tunneling/memif-to-decap SCION gateway: trace all ingress frames entering via memif.
VppApi get_debug_vpp_scion_tunneling_memif_to_encap GET /debug/vpp/scion-tunneling/memif-to-encap SCION gateway: trace all egress IP packets entering via memif.
VppApi get_debug_vpp_scion_tunneling_path GET /debug/vpp/scion-tunneling/path SCION gateway: known paths.
VppApi get_debug_vpp_scion_tunneling_routing GET /debug/vpp/scion-tunneling/routing SCION gateway: routing hierarchy.
VppApi get_debug_vpp_scion_tunneling_routing_chain GET /debug/vpp/scion-tunneling/routing-chain SCION gateway: routing chains.
VppApi get_debug_vpp_scion_tunneling_session GET /debug/vpp/scion-tunneling/session SCION gateway: sessions.
VppApi get_debug_vpp_scion_tunneling_traffic_class GET /debug/vpp/scion-tunneling/traffic-class SCION gateway: traffic classes.
VppApi get_debug_vpp_scion_tunneling_tun GET /debug/vpp/scion-tunneling/tun SCION gateway: TUN device.
VppApi get_debug_vpp_trace GET /debug/vpp/trace Action path to execute free form packet trace.
VppApi get_debug_vpp_trace_dpdk GET /debug/vpp/trace/dpdk Action path to execute a trace for packets entering via DPDK.
VppApi get_debug_vpp_trace_memif GET /debug/vpp/trace/memif Action path to execute a trace for packets entering via memif.
VppApi get_debug_vpp_trace_start GET /debug/vpp/trace/start Action path that starts a trace without timeout. The trace can be stopped with the `/vpp/trace/stop` endpoint.
VppApi get_debug_vpp_trace_stop GET /debug/vpp/trace/stop Action path that stops tracing.
VppApi get_debug_vpp_trace_udp4_socket GET /debug/vpp/trace/udp4-socket Action path to execute a trace for IPv4 packets entering via VPP UDP socket.
VppApi get_debug_vpp_trace_udp6_socket GET /debug/vpp/trace/udp6-socket Action path to execute a trace for IPv6 packets entering via VPP UDP socket.
VppApi get_debug_vpp_trace_virtio GET /debug/vpp/trace/virtio Action path to execute a trace for packets entering via TUN/TAP.
VppApi get_debug_vpp_tun GET /debug/vpp/tun Status page reporting TUN/TAP devices created by VPP.
VppApi get_debug_vpp_vrrp GET /debug/vpp/vrrp VRRP summary.
VppTraceApi get_debug_vpp_trace GET /debug/vpp/trace Action path to execute free form packet trace.
VppTraceApi get_debug_vpp_trace_dpdk GET /debug/vpp/trace/dpdk Action path to execute a trace for packets entering via DPDK.
VppTraceApi get_debug_vpp_trace_memif GET /debug/vpp/trace/memif Action path to execute a trace for packets entering via memif.
VppTraceApi get_debug_vpp_trace_start GET /debug/vpp/trace/start Action path that starts a trace without timeout. The trace can be stopped with the `/vpp/trace/stop` endpoint.
VppTraceApi get_debug_vpp_trace_stop GET /debug/vpp/trace/stop Action path that stops tracing.
VppTraceApi get_debug_vpp_trace_udp4_socket GET /debug/vpp/trace/udp4-socket Action path to execute a trace for IPv4 packets entering via VPP UDP socket.
VppTraceApi get_debug_vpp_trace_udp6_socket GET /debug/vpp/trace/udp6-socket Action path to execute a trace for IPv6 packets entering via VPP UDP socket.
VppTraceApi get_debug_vpp_trace_virtio GET /debug/vpp/trace/virtio Action path to execute a trace for packets entering via TUN/TAP.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

ops@anapaya.net

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for anapaya from gravatar.com anapaya Avatar for worxli from gravatar.com worxli

Unverified details

These details have not been verified by PyPI
Meta
  • Requires: Python >=3.7

Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anapaya_appliance-0.1.tar.gz (404.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anapaya_appliance-0.1-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file anapaya_appliance-0.1.tar.gz.

File metadata

  • Download URL: anapaya_appliance-0.1.tar.gz
  • Upload date:
  • Size: 404.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for anapaya_appliance-0.1.tar.gz
Algorithm Hash digest
SHA256 88b73d8d16f23e24acd797bf685b9ff77ba6df4ebb299fa4d5714efcbe2944a7
MD5 178f0aa2c16c3433d32714f3a1186205
BLAKE2b-256 7723d99e20c0808ceadce19ea0b138aa137b604f79cc817d645f1cd37661f891

See more details on using hashes here.

File details

Details for the file anapaya_appliance-0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for anapaya_appliance-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66700b427f099b48261130a56de23d26eef1ae8b3fd3426b35d3db45460d22c4
MD5 4d9c2dea338f6c19b23908b0fbdb7d7f
BLAKE2b-256 85deb36d3eab47d9701cb2a19610737d01c66328f5e48ecc9b9585d6622d268f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page