Skip to content

pmajumdarKS/cyperf

BranchesTags

Repository files navigation

cyperf

CyPerf REST API

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.8.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install cyperf

(you may need to run pip with root permission: sudo pip install cyperf)

Then import the package:

import cyperf

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import cyperf

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.AgentsApi(api_client)
    agent_id = 'agent_id_example' # str | The ID of the agent.

    try:
        api_instance.delete_agents(agent_id)
    except ApiException as e:
        print("Exception when calling AgentsApi->delete_agents: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AgentsApi delete_agents DELETE /api/v2/agents/{agentId}
AgentsApi get_agents GET /api/v2/agents
AgentsApi get_agents_by_id GET /api/v2/agents/{agentId}
AgentsApi get_agents_tags GET /api/v2/tags
AgentsApi get_controllers GET /api/v2/controllers
AgentsApi get_controllers_by_id GET /api/v2/controllers/{controllerId}
AgentsApi patch_agents PATCH /api/v2/agents/{agentId}
AgentsApi poll_compute_nodes_switch_aggregation_mode GET /api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId}/operations/switch-aggregation-mode/{id}
AgentsApi poll_controllers_switch_app GET /api/v2/controllers/{controllerId}/operations/switch-app/{id}
AgentsApi poll_root_batch_delete GET /api/v2/agents/operations/batch-delete/{id}
AgentsApi poll_root_export_files GET /api/v2/agents/operations/exportFiles/{id}
AgentsApi poll_root_reboot GET /api/v2/agents/operations/reboot/{id}
AgentsApi poll_root_release GET /api/v2/agents/operations/release/{id}
AgentsApi poll_root_reserve GET /api/v2/agents/operations/reserve/{id}
AgentsApi poll_root_set_dpdk_mode GET /api/v2/agents/operations/set-dpdk-mode/{id}
AgentsApi poll_root_set_ntp GET /api/v2/agents/operations/set-ntp/{id}
AgentsApi poll_root_update GET /api/v2/agents/operations/update/{id}
AgentsApi start_compute_nodes_switch_aggregation_mode POST /api/v2/controllers/{controllerId}/compute-nodes/{computeNodeId}/operations/switch-aggregation-mode
AgentsApi start_controllers_switch_app POST /api/v2/controllers/{controllerId}/operations/switch-app
AgentsApi start_root_batch_delete POST /api/v2/agents/operations/batch-delete
AgentsApi start_root_export_files POST /api/v2/agents/operations/exportFiles
AgentsApi start_root_reboot POST /api/v2/agents/operations/reboot
AgentsApi start_root_release POST /api/v2/agents/operations/release
AgentsApi start_root_reserve POST /api/v2/agents/operations/reserve
AgentsApi start_root_set_dpdk_mode POST /api/v2/agents/operations/set-dpdk-mode
AgentsApi start_root_set_ntp POST /api/v2/agents/operations/set-ntp
AgentsApi start_root_update POST /api/v2/agents/operations/update
ApplicationResourcesApi create_resources_captures_operations_upload_file POST /api/v2/resources/captures/operations/uploadFile
ApplicationResourcesApi create_resources_certificates_operations_upload_file POST /api/v2/resources/certificates/operations/uploadFile
ApplicationResourcesApi create_resources_flow_library_operations_upload_file POST /api/v2/resources/flow-library/operations/uploadFile
ApplicationResourcesApi create_resources_global_playlists_operations_upload_file POST /api/v2/resources/global-playlists/operations/uploadFile
ApplicationResourcesApi create_resources_http_library_operations_upload_file POST /api/v2/resources/http-library/operations/uploadFile
ApplicationResourcesApi create_resources_media_files_operations_upload_file POST /api/v2/resources/media-files/operations/uploadFile
ApplicationResourcesApi create_resources_media_library_operations_upload_file POST /api/v2/resources/media-library/operations/uploadFile
ApplicationResourcesApi create_resources_other_library_operations_upload_file POST /api/v2/resources/other-library/operations/uploadFile
ApplicationResourcesApi create_resources_payloads_operations_upload_file POST /api/v2/resources/payloads/operations/uploadFile
ApplicationResourcesApi create_resources_pcaps_operations_upload_file POST /api/v2/resources/pcaps/operations/uploadFile
ApplicationResourcesApi create_resources_playlists_operations_upload_file POST /api/v2/resources/playlists/operations/uploadFile
ApplicationResourcesApi create_resources_sip_library_operations_upload_file POST /api/v2/resources/sip-library/operations/uploadFile
ApplicationResourcesApi create_resources_stats_profile_operations_upload_file POST /api/v2/resources/stats-profile/operations/uploadFile
ApplicationResourcesApi create_resources_tls_certificates_operations_upload_file POST /api/v2/resources/tls-certificates/operations/uploadFile
ApplicationResourcesApi create_resources_tls_dhs_operations_upload_file POST /api/v2/resources/tls-dhs/operations/uploadFile
ApplicationResourcesApi create_resources_tls_keys_operations_upload_file POST /api/v2/resources/tls-keys/operations/uploadFile
ApplicationResourcesApi delete_captures DELETE /api/v2/resources/captures/{captureId}
ApplicationResourcesApi delete_certificates DELETE /api/v2/resources/certificates/{certificateId}
ApplicationResourcesApi delete_flow_library DELETE /api/v2/resources/flow-library/{flowLibraryId}
ApplicationResourcesApi delete_global_playlists DELETE /api/v2/resources/global-playlists/{globalPlaylistId}
ApplicationResourcesApi delete_http_library DELETE /api/v2/resources/http-library/{httpLibraryId}
ApplicationResourcesApi delete_media_files DELETE /api/v2/resources/media-files/{mediaFileId}
ApplicationResourcesApi delete_media_library DELETE /api/v2/resources/media-library/{mediaLibraryId}
ApplicationResourcesApi delete_other_library DELETE /api/v2/resources/other-library/{otherLibraryId}
ApplicationResourcesApi delete_payloads DELETE /api/v2/resources/payloads/{payloadId}
ApplicationResourcesApi delete_pcaps DELETE /api/v2/resources/pcaps/{pcapId}
ApplicationResourcesApi delete_playlists DELETE /api/v2/resources/playlists/{playlistId}
ApplicationResourcesApi delete_sip_library DELETE /api/v2/resources/sip-library/{sipLibraryId}
ApplicationResourcesApi delete_stats_profile DELETE /api/v2/resources/stats-profile/{statsProfileId}
ApplicationResourcesApi delete_tls_certificates DELETE /api/v2/resources/tls-certificates/{tlsCertificateId}
ApplicationResourcesApi delete_tls_dhs DELETE /api/v2/resources/tls-dhs/{tlsDhId}
ApplicationResourcesApi delete_tls_keys DELETE /api/v2/resources/tls-keys/{tlsKeyId}
ApplicationResourcesApi get_application_types GET /api/v2/resources/application-types
ApplicationResourcesApi get_application_types_by_id GET /api/v2/resources/application-types/{applicationTypeId}
ApplicationResourcesApi get_apps GET /api/v2/resources/apps
ApplicationResourcesApi get_apps_by_id GET /api/v2/resources/apps/{appId}
ApplicationResourcesApi get_attack_categories GET /api/v2/resources/attack-categories
ApplicationResourcesApi get_attacks GET /api/v2/resources/attacks
ApplicationResourcesApi get_attacks_by_id GET /api/v2/resources/attacks/{attackId}
ApplicationResourcesApi get_auth_profiles GET /api/v2/resources/auth-profiles
ApplicationResourcesApi get_auth_profiles_by_id GET /api/v2/resources/auth-profiles/{authProfileId}
ApplicationResourcesApi get_captures GET /api/v2/resources/captures
ApplicationResourcesApi get_captures_by_id GET /api/v2/resources/captures/{captureId}
ApplicationResourcesApi get_certificates GET /api/v2/resources/certificates
ApplicationResourcesApi get_certificates_by_id GET /api/v2/resources/certificates/{certificateId}
ApplicationResourcesApi get_flow_library GET /api/v2/resources/flow-library
ApplicationResourcesApi get_flow_library_by_id GET /api/v2/resources/flow-library/{flowLibraryId}
ApplicationResourcesApi get_global_playlists GET /api/v2/resources/global-playlists
ApplicationResourcesApi get_global_playlists_by_id GET /api/v2/resources/global-playlists/{globalPlaylistId}
ApplicationResourcesApi get_http_library GET /api/v2/resources/http-library
ApplicationResourcesApi get_http_library_by_id GET /api/v2/resources/http-library/{httpLibraryId}
ApplicationResourcesApi get_http_profiles GET /api/v2/resources/http-profiles
ApplicationResourcesApi get_http_profiles_by_id GET /api/v2/resources/http-profiles/{httpProfileId}
ApplicationResourcesApi get_media_files GET /api/v2/resources/media-files
ApplicationResourcesApi get_media_files_by_id GET /api/v2/resources/media-files/{mediaFileId}
ApplicationResourcesApi get_media_library GET /api/v2/resources/media-library
ApplicationResourcesApi get_media_library_by_id GET /api/v2/resources/media-library/{mediaLibraryId}
ApplicationResourcesApi get_other_library GET /api/v2/resources/other-library
ApplicationResourcesApi get_other_library_by_id GET /api/v2/resources/other-library/{otherLibraryId}
ApplicationResourcesApi get_payloads GET /api/v2/resources/payloads
ApplicationResourcesApi get_payloads_by_id GET /api/v2/resources/payloads/{payloadId}
ApplicationResourcesApi get_pcaps GET /api/v2/resources/pcaps
ApplicationResourcesApi get_pcaps_by_id GET /api/v2/resources/pcaps/{pcapId}
ApplicationResourcesApi get_playlists GET /api/v2/resources/playlists
ApplicationResourcesApi get_playlists_by_id GET /api/v2/resources/playlists/{playlistId}
ApplicationResourcesApi get_resources_captures_operations_upload_file_operation_id GET /api/v2/resources/captures/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_captures_operations_upload_file_operation_id_result GET /api/v2/resources/captures/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_certificates_certificates_id_content_file GET /api/v2/resources/certificates/{certificateId}/contentFile
ApplicationResourcesApi get_resources_certificates_operations_upload_file_operation_id GET /api/v2/resources/certificates/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_certificates_operations_upload_file_operation_id_result GET /api/v2/resources/certificates/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_flow_library_flow_library_id_content_file GET /api/v2/resources/flow-library/{flowLibraryId}/contentFile
ApplicationResourcesApi get_resources_flow_library_operations_upload_file_operation_id GET /api/v2/resources/flow-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_flow_library_operations_upload_file_operation_id_result GET /api/v2/resources/flow-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_global_playlists_global_playlists_id_content_file GET /api/v2/resources/global-playlists/{globalPlaylistId}/contentFile
ApplicationResourcesApi get_resources_global_playlists_operations_upload_file_operation_id GET /api/v2/resources/global-playlists/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_global_playlists_operations_upload_file_operation_id_result GET /api/v2/resources/global-playlists/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_http_library_http_library_id_content_file GET /api/v2/resources/http-library/{httpLibraryId}/contentFile
ApplicationResourcesApi get_resources_http_library_operations_upload_file_operation_id GET /api/v2/resources/http-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_http_library_operations_upload_file_operation_id_result GET /api/v2/resources/http-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_media_files_media_files_id_content_file GET /api/v2/resources/media-files/{mediaFileId}/contentFile
ApplicationResourcesApi get_resources_media_files_operations_upload_file_operation_id GET /api/v2/resources/media-files/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_media_files_operations_upload_file_operation_id_result GET /api/v2/resources/media-files/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_media_library_media_library_id_content_file GET /api/v2/resources/media-library/{mediaLibraryId}/contentFile
ApplicationResourcesApi get_resources_media_library_operations_upload_file_operation_id GET /api/v2/resources/media-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_media_library_operations_upload_file_operation_id_result GET /api/v2/resources/media-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_other_library_operations_upload_file_operation_id GET /api/v2/resources/other-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_other_library_operations_upload_file_operation_id_result GET /api/v2/resources/other-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_other_library_other_library_id_content_file GET /api/v2/resources/other-library/{otherLibraryId}/contentFile
ApplicationResourcesApi get_resources_payloads_operations_upload_file_operation_id GET /api/v2/resources/payloads/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_payloads_operations_upload_file_operation_id_result GET /api/v2/resources/payloads/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_payloads_payloads_id_content_file GET /api/v2/resources/payloads/{payloadId}/contentFile
ApplicationResourcesApi get_resources_pcaps_operations_upload_file_operation_id GET /api/v2/resources/pcaps/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_pcaps_operations_upload_file_operation_id_result GET /api/v2/resources/pcaps/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_pcaps_pcaps_id_content_file GET /api/v2/resources/pcaps/{pcapId}/contentFile
ApplicationResourcesApi get_resources_playlists_operations_upload_file_operation_id GET /api/v2/resources/playlists/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_playlists_operations_upload_file_operation_id_result GET /api/v2/resources/playlists/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_playlists_playlists_id_content_file GET /api/v2/resources/playlists/{playlistId}/contentFile
ApplicationResourcesApi get_resources_playlists_playlists_id_values GET /api/v2/resources/playlists/{playlistId}/values
ApplicationResourcesApi get_resources_sip_library_operations_upload_file_operation_id GET /api/v2/resources/sip-library/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_sip_library_operations_upload_file_operation_id_result GET /api/v2/resources/sip-library/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_sip_library_sip_library_id_content_file GET /api/v2/resources/sip-library/{sipLibraryId}/contentFile
ApplicationResourcesApi get_resources_stats_profile_operations_upload_file_operation_id GET /api/v2/resources/stats-profile/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_stats_profile_operations_upload_file_operation_id_result GET /api/v2/resources/stats-profile/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_stats_profile_stats_profile_id_content_file GET /api/v2/resources/stats-profile/{statsProfileId}/contentFile
ApplicationResourcesApi get_resources_tls_certificates_operations_upload_file_operation_id GET /api/v2/resources/tls-certificates/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_tls_certificates_operations_upload_file_operation_id_result GET /api/v2/resources/tls-certificates/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_tls_certificates_tls_certificates_id_content_file GET /api/v2/resources/tls-certificates/{tlsCertificateId}/contentFile
ApplicationResourcesApi get_resources_tls_dhs_operations_upload_file_operation_id GET /api/v2/resources/tls-dhs/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_tls_dhs_operations_upload_file_operation_id_result GET /api/v2/resources/tls-dhs/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_tls_dhs_tls_dhs_id_content_file GET /api/v2/resources/tls-dhs/{tlsDhId}/contentFile
ApplicationResourcesApi get_resources_tls_keys_operations_upload_file_operation_id GET /api/v2/resources/tls-keys/operations/uploadFile/{uploadFileId}
ApplicationResourcesApi get_resources_tls_keys_operations_upload_file_operation_id_result GET /api/v2/resources/tls-keys/operations/uploadFile/{uploadFileId}/result
ApplicationResourcesApi get_resources_tls_keys_tls_keys_id_content_file GET /api/v2/resources/tls-keys/{tlsKeyId}/contentFile
ApplicationResourcesApi get_sip_library GET /api/v2/resources/sip-library
ApplicationResourcesApi get_sip_library_by_id GET /api/v2/resources/sip-library/{sipLibraryId}
ApplicationResourcesApi get_stats_profile GET /api/v2/resources/stats-profile
ApplicationResourcesApi get_stats_profile_by_id GET /api/v2/resources/stats-profile/{statsProfileId}
ApplicationResourcesApi get_strike_categories GET /api/v2/resources/strike-categories
ApplicationResourcesApi get_strikes GET /api/v2/resources/strikes
ApplicationResourcesApi get_strikes_by_id GET /api/v2/resources/strikes/{strikeId}
ApplicationResourcesApi get_tls_certificates GET /api/v2/resources/tls-certificates
ApplicationResourcesApi get_tls_certificates_by_id GET /api/v2/resources/tls-certificates/{tlsCertificateId}
ApplicationResourcesApi get_tls_dhs GET /api/v2/resources/tls-dhs
ApplicationResourcesApi get_tls_dhs_by_id GET /api/v2/resources/tls-dhs/{tlsDhId}
ApplicationResourcesApi get_tls_keys GET /api/v2/resources/tls-keys
ApplicationResourcesApi get_tls_keys_by_id GET /api/v2/resources/tls-keys/{tlsKeyId}
ApplicationResourcesApi poll_root_create_app GET /api/v2/resources/operations/create-app/{id}
ApplicationResourcesApi poll_root_get_attack_categories GET /api/v2/resources/operations/get-attack-categories/{id}
ApplicationResourcesApi poll_root_get_attacks GET /api/v2/resources/operations/get-attacks/{id}
ApplicationResourcesApi poll_root_get_strike_categories GET /api/v2/resources/operations/get-strike-categories/{id}
ApplicationResourcesApi poll_root_get_strikes GET /api/v2/resources/operations/get-strikes/{id}
ApplicationResourcesApi start_root_create_app POST /api/v2/resources/operations/create-app
ApplicationResourcesApi start_root_get_attack_categories POST /api/v2/resources/operations/get-attack-categories
ApplicationResourcesApi start_root_get_attacks POST /api/v2/resources/operations/get-attacks
ApplicationResourcesApi start_root_get_strike_categories POST /api/v2/resources/operations/get-strike-categories
ApplicationResourcesApi start_root_get_strikes POST /api/v2/resources/operations/get-strikes
AuthorizationApi auth_realms_keysight_protocol_openid_connect_token_post POST /auth/realms/keysight/protocol/openid-connect/token
BrokersApi create_brokers POST /api/v2/brokers
BrokersApi delete_brokers DELETE /api/v2/brokers/{brokerId}
BrokersApi get_brokers GET /api/v2/brokers
BrokersApi get_brokers_by_id GET /api/v2/brokers/{brokerId}
BrokersApi patch_brokers PATCH /api/v2/brokers/{brokerId}
ConfigurationsApi create_configs POST /api/v2/configs
ConfigurationsApi delete_configs DELETE /api/v2/configs/{configId}
ConfigurationsApi get_config_categories GET /api/v2/config-categories
ConfigurationsApi get_configs GET /api/v2/configs
ConfigurationsApi get_configs_by_id GET /api/v2/configs/{configId}
ConfigurationsApi get_custom_import_operations GET /api/v2/resources/custom-import-operations
ConfigurationsApi patch_configs PATCH /api/v2/configs/{configId}
ConfigurationsApi poll_configs_batch_delete GET /api/v2/configs/operations/batch-delete/{id}
ConfigurationsApi poll_configs_export_all GET /api/v2/configs/operations/exportAll/{id}
ConfigurationsApi poll_configs_import GET /api/v2/configs/operations/import/{id}
ConfigurationsApi poll_configs_import_all GET /api/v2/configs/operations/importAll/{id}
ConfigurationsApi start_configs_batch_delete POST /api/v2/configs/operations/batch-delete
ConfigurationsApi start_configs_export_all POST /api/v2/configs/operations/exportAll
ConfigurationsApi start_configs_import POST /api/v2/configs/operations/import
ConfigurationsApi start_configs_import_all POST /api/v2/configs/operations/importAll
ConfigurationsApi update_configs PUT /api/v2/configs/{configId}
DataMigrationApi poll_root_export GET /api/v2/controller-migration/operations/export/{id}
DataMigrationApi poll_root_import GET /api/v2/controller-migration/operations/import/{id}
DataMigrationApi start_root_export POST /api/v2/controller-migration/operations/export
DataMigrationApi start_root_import POST /api/v2/controller-migration/operations/import
DiagnosticsApi api_v2_diagnostics_components_get GET /api/v2/diagnostics/components
DiagnosticsApi api_v2_diagnostics_operations_delete_delete DELETE /api/v2/diagnostics/operations/delete
DiagnosticsApi api_v2_diagnostics_operations_delete_id_delete DELETE /api/v2/diagnostics/operations/delete/{id}
DiagnosticsApi api_v2_diagnostics_operations_export_get GET /api/v2/diagnostics/operations/export
DiagnosticsApi api_v2_diagnostics_operations_export_id_get GET /api/v2/diagnostics/operations/export/{id}
DiagnosticsApi api_v2_diagnostics_operations_export_id_result_get GET /api/v2/diagnostics/operations/export/{id}/result
DiagnosticsApi api_v2_diagnostics_operations_export_post POST /api/v2/diagnostics/operations/export
LicenseServersApi create_license_servers POST /api/v2/license-servers
LicenseServersApi delete_license_servers DELETE /api/v2/license-servers/{licenseServerId}
LicenseServersApi get_license_servers GET /api/v2/license-servers
LicenseServersApi get_license_servers_by_id GET /api/v2/license-servers/{licenseServerId}
LicenseServersApi patch_license_servers PATCH /api/v2/license-servers/{licenseServerId}
LicensingApi activate_licenses POST /api/v2/licensing/operations/activate Performs an online request to KSM and activates the requested licenses.
LicensingApi deactivate_licenses POST /api/v2/licensing/operations/deactivate Performs an online request to KSM to deactivate the requested licenses.
LicensingApi generate_offline_request GET /api/v2/licensing/generate-offline-request Generates an offline request that can be used on the offline licensing portal.
LicensingApi get_activation_code_info POST /api/v2/licensing/operations/retrieve-activation-code-info Retrieves the activation code info from KSM.
LicensingApi get_activation_code_info_list POST /api/v2/licensing/operations/retrieve-activation-code-info-list Retrieves the activation code info list from KSM.
LicensingApi get_async_operation_result GET /api/v2/licensing/operations/{operationType}/{id}/result Returns the result of async operation.
LicensingApi get_async_operation_status GET /api/v2/licensing/operations/{operationType}/{id} Returns the status of an ongoing async operation.
LicensingApi get_counted_feature_stats POST /api/v2/licensing/operations/retrieve-counted-feature-stats Retrieves the counted feature stats.
LicensingApi get_entitlement_code_info POST /api/v2/licensing/operations/retrieve-entitlement-code-info Retrieves the activations codes of the supplied entitlement code from KSM.
LicensingApi get_hostid GET /api/v2/licensing/hostid Retrieves the host ID of the license server.
LicensingApi get_installed_licenses GET /api/v2/licensing/licenses Returns the installed licenses.
LicensingApi get_license GET /api/v2/licensing/licenses/{licenseId} Returns the requested license.
LicensingApi get_license_async_operation_result GET /api/v2/licensing/licenses/{licenseId}/operations/{operationType}/{id}/result Returns the result of async operation.
LicensingApi get_license_async_operation_status GET /api/v2/licensing/licenses/{licenseId}/operations/{operationType}/{id} Returns the status of an ongoing async operation.
LicensingApi import_offline_license POST /api/v2/licensing/import-offline-license Installs the offline license.
LicensingApi remove_reservation POST /api/v2/licensing/licenses/{licenseId}/operations/reservation-remove Remove previously reserved features, thus making them available for checkout by other users.
LicensingApi sync_licenses POST /api/v2/licensing/operations/synchronize-licenses Synchronize local licenses with KSM.
LicensingApi test_backend_connectivity POST /api/v2/licensing/operations/test-backend-connectivity Tests connection of the license server with KSM.
LicensingApi update_reservation POST /api/v2/licensing/licenses/{licenseId}/operations/reservation-reserve Retain over a period of time specific counts of installed features, that can be consumed only by current user.
NotificationsApi delete_notifications DELETE /api/v2/notifications/{notificationId}
NotificationsApi get_notification_counts GET /api/v2/notification-counts
NotificationsApi get_notifications GET /api/v2/notifications
NotificationsApi get_notifications_by_id GET /api/v2/notifications/{notificationId}
NotificationsApi poll_notifications_cleanup GET /api/v2/notifications/operations/cleanup/{id}
NotificationsApi poll_notifications_dismiss GET /api/v2/notifications/operations/dismiss/{id}
NotificationsApi start_notifications_cleanup POST /api/v2/notifications/operations/cleanup
NotificationsApi start_notifications_dismiss POST /api/v2/notifications/operations/dismiss
ReportsApi download_pdf GET /api/v2/results/{resultId}/download-pdf/{pdfId}
ReportsApi get_download_csv_by_id GET /api/v2/results/{resultId}/download-csv/{downloadCsvId}
ReportsApi poll_results_generate_csv GET /api/v2/results/{resultId}/operations/generate-csv/{id}
ReportsApi poll_results_generate_pdf GET /api/v2/results/{resultId}/operations/generate-pdf/{id}
ReportsApi start_results_generate_csv POST /api/v2/results/{resultId}/operations/generate-csv
ReportsApi start_results_generate_pdf POST /api/v2/results/{resultId}/operations/generate-pdf
SessionsApi create_meta POST /api/v2/sessions/{sessionId}/meta
SessionsApi create_sessions POST /api/v2/sessions
SessionsApi delete_meta DELETE /api/v2/sessions/{sessionId}/meta/{metaId}
SessionsApi delete_sessions DELETE /api/v2/sessions/{sessionId}
SessionsApi get_appsec_ui_metadata GET /api/v2/appsec-ui-metadata
SessionsApi get_config GET /api/v2/sessions/{sessionId}/config
SessionsApi get_docs GET /api/v2/sessions/{sessionId}/config/$docs
SessionsApi get_granular_stats GET /api/v2/sessions/{sessionId}/config/granular-stats
SessionsApi get_granular_stats_filters GET /api/v2/sessions/{sessionId}/config/granular-stats-filters
SessionsApi get_meta GET /api/v2/sessions/{sessionId}/meta
SessionsApi get_meta_by_id GET /api/v2/sessions/{sessionId}/meta/{metaId}
SessionsApi get_sessions GET /api/v2/sessions
SessionsApi get_sessions_by_id GET /api/v2/sessions/{sessionId}
SessionsApi get_test GET /api/v2/sessions/{sessionId}/test
SessionsApi patch_meta PATCH /api/v2/sessions/{sessionId}/meta/{metaId}
SessionsApi patch_sessions PATCH /api/v2/sessions/{sessionId}
SessionsApi patch_test PATCH /api/v2/sessions/{sessionId}/test
SessionsApi poll_config_granular_stats_default_dashboards GET /api/v2/sessions/{sessionId}/config/operations/granular-stats-default-dashboards/{id}
SessionsApi poll_config_save GET /api/v2/sessions/{sessionId}/config/operations/save/{id}
SessionsApi poll_root_prepare_test GET /api/v2/sessions/{sessionId}/operations/prepareTest/{id}
SessionsApi poll_root_test_end GET /api/v2/sessions/{sessionId}/operations/testEnd/{id}
SessionsApi poll_root_test_init GET /api/v2/sessions/{sessionId}/operations/testInit/{id}
SessionsApi poll_sessions_batch_delete GET /api/v2/sessions/operations/batch-delete/{id}
SessionsApi poll_sessions_load_config GET /api/v2/sessions/{sessionId}/operations/loadConfig/{id}
SessionsApi poll_sessions_touch GET /api/v2/sessions/{sessionId}/operations/touch/{id}
SessionsApi start_config_granular_stats_default_dashboards POST /api/v2/sessions/{sessionId}/config/operations/granular-stats-default-dashboards
SessionsApi start_config_save POST /api/v2/sessions/{sessionId}/config/operations/save
SessionsApi start_root_prepare_test POST /api/v2/sessions/{sessionId}/operations/prepareTest
SessionsApi start_root_test_end POST /api/v2/sessions/{sessionId}/operations/testEnd
SessionsApi start_root_test_init POST /api/v2/sessions/{sessionId}/operations/testInit
SessionsApi start_sessions_batch_delete POST /api/v2/sessions/operations/batch-delete
SessionsApi start_sessions_load_config POST /api/v2/sessions/{sessionId}/operations/loadConfig
SessionsApi start_sessions_touch POST /api/v2/sessions/{sessionId}/operations/touch
SessionsApi update_config PUT /api/v2/sessions/{sessionId}/config
SessionsApi update_meta PUT /api/v2/sessions/{sessionId}/meta
SessionsApi update_sessions PUT /api/v2/sessions/{sessionId}
SessionsApi update_test PUT /api/v2/sessions/{sessionId}/test
StatisticsApi create_plugins POST /api/v2/stats/plugins
StatisticsApi delete_plugins DELETE /api/v2/stats/plugins/{pluginId}
StatisticsApi get_plugins GET /api/v2/stats/plugins
StatisticsApi get_stats GET /api/v2/results/{resultId}/stats
StatisticsApi get_stats_by_id GET /api/v2/results/{resultId}/stats/{statId}
StatisticsApi poll_plugins_ingest GET /api/v2/stats/plugins/operations/ingest/{id}
StatisticsApi start_plugins_ingest POST /api/v2/stats/plugins/operations/ingest
TestOperationsApi poll_root_abort GET /api/v2/sessions/{sessionId}/test-run/operations/abort/{id}
TestOperationsApi poll_root_start GET /api/v2/sessions/{sessionId}/test-calibrate/operations/start/{id}
TestOperationsApi poll_root_stop GET /api/v2/sessions/{sessionId}/test-calibrate/operations/stop/{id}
TestOperationsApi poll_test_start GET /api/v2/sessions/{sessionId}/test-run/operations/start/{id}
TestOperationsApi poll_test_stop GET /api/v2/sessions/{sessionId}/test-run/operations/stop/{id}
TestOperationsApi start_root_start POST /api/v2/sessions/{sessionId}/test-calibrate/operations/start
TestOperationsApi start_root_stop POST /api/v2/sessions/{sessionId}/test-calibrate/operations/stop
TestOperationsApi start_test_abort POST /api/v2/sessions/{sessionId}/test-run/operations/abort
TestOperationsApi start_test_start POST /api/v2/sessions/{sessionId}/test-run/operations/start
TestOperationsApi start_test_stop POST /api/v2/sessions/{sessionId}/test-run/operations/stop
TestResultsApi delete_files DELETE /api/v2/results/{resultId}/files/{fileId}
TestResultsApi delete_results DELETE /api/v2/results/{resultId}
TestResultsApi get_download_all_by_id GET /api/v2/results/{resultId}/download-all/{downloadAllId}
TestResultsApi get_download_result_config GET /api/v2/results/{resultId}/download-result-config
TestResultsApi get_files GET /api/v2/results/{resultId}/files
TestResultsApi get_files_by_id GET /api/v2/results/{resultId}/files/{fileId}
TestResultsApi get_results GET /api/v2/results
TestResultsApi get_results_by_id GET /api/v2/results/{resultId}
TestResultsApi get_results_results_id_files_files_id_content GET /api/v2/results/{resultId}/files/{fileId}/content
TestResultsApi get_results_tags GET /api/v2/results/tags
TestResultsApi poll_results_batch_delete GET /api/v2/results/operations/batch-delete/{id}
TestResultsApi poll_results_generate_all GET /api/v2/results/{resultId}/operations/generate-all/{id}
TestResultsApi poll_results_generate_results GET /api/v2/results/{resultId}/operations/generate-results/{id}
TestResultsApi poll_results_load GET /api/v2/results/{resultId}/operations/load/{id}
TestResultsApi start_results_batch_delete POST /api/v2/results/operations/batch-delete
TestResultsApi start_results_generate_all POST /api/v2/results/{resultId}/operations/generate-all
TestResultsApi start_results_generate_results POST /api/v2/results/{resultId}/operations/generate-results
TestResultsApi start_results_load POST /api/v2/results/{resultId}/operations/load
UtilsApi get_certificate GET /api/v2/cert-manager/certificate
UtilsApi get_consumers GET /api/v2/disk-usage/consumers
UtilsApi get_consumers_by_id GET /api/v2/disk-usage/consumers/{consumerId}
UtilsApi get_disk_usage GET /api/v2/disk-usage
UtilsApi get_docs GET /api/v2/docs
UtilsApi get_docs_json GET /api/v2/docs.json
UtilsApi get_docs_yaml GET /api/v2/docs.yaml
UtilsApi get_log_config GET /api/v2/log-config
UtilsApi get_time GET /api/v2/time
UtilsApi poll_disk_usage_cleanup_diagnostics GET /api/v2/disk-usage/operations/cleanup-diagnostics/{id}
UtilsApi poll_disk_usage_cleanup_logs GET /api/v2/disk-usage/operations/cleanup-logs/{id}
UtilsApi poll_disk_usage_cleanup_migration GET /api/v2/disk-usage/operations/cleanup-migration/{id}
UtilsApi poll_disk_usage_cleanup_notifications GET /api/v2/disk-usage/operations/cleanup-notifications/{id}
UtilsApi poll_disk_usage_cleanup_results GET /api/v2/disk-usage/operations/cleanup-results/{id}
UtilsApi poll_root_generate GET /api/v2/cert-manager/operations/generate/{id}
UtilsApi poll_root_upload GET /api/v2/cert-manager/operations/upload/{id}
UtilsApi start_disk_usage_cleanup_diagnostics POST /api/v2/disk-usage/operations/cleanup-diagnostics
UtilsApi start_disk_usage_cleanup_logs POST /api/v2/disk-usage/operations/cleanup-logs
UtilsApi start_disk_usage_cleanup_migration POST /api/v2/disk-usage/operations/cleanup-migration
UtilsApi start_disk_usage_cleanup_notifications POST /api/v2/disk-usage/operations/cleanup-notifications
UtilsApi start_disk_usage_cleanup_results POST /api/v2/disk-usage/operations/cleanup-results
UtilsApi start_root_generate POST /api/v2/cert-manager/operations/generate
UtilsApi start_root_upload POST /api/v2/cert-manager/operations/upload
UtilsApi update_log_config PUT /api/v2/log-config

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
  • offline_access: Required.
  • openid: Required.

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /auth/realms/keysight/protocol/openid-connect/auth
  • Scopes:
  • offline_access: Required.
  • openid: Required.

Author

About

A python module for calling CyPerf REST APIs

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

1 watching

Forks

1 fork
Report repository

Releases

1 tags

Packages

No packages published

Languages